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

lockss/pyclient/config/swagger.yaml

@@ -0,0 +1,2031 @@
+# 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 Configuration Service REST API
+  description: REST API of the LOCKSS Configuration 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 Configuration 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: 24612)."
+        default: 24612
+security:
+  - basicAuth: []
+tags:
+  - name: aus
+    description: Archival unit (AU) operations
+  - name: config
+    description: Configuration operations
+  - name: plugin
+    description: Plugin operations
+  - name: status
+    description: Status operations
+  - name: tdb
+    description: Title database (TDB) operations
+  - name: users
+    description: User operations
+  - name: utils
+    description: Miscellaneous operations
+paths:
+  /config/file/{sectionName}:
+    get:
+      tags:
+        - config
+      summary: Get the named configuration file
+      description: Get the configuration file stored for a given name
+      operationId: getSectionConfig
+      # roles: ROLE_USER_ADMIN
+      parameters:
+        - name: sectionName
+          in: path
+          description: The name of the section for which the configuration file is
+            requested
+          required: true
+          schema:
+            type: string
+        - name: If-Match
+          in: header
+          description: The If-Match header
+          schema:
+            type: string
+        - name: If-Modified-Since
+          in: header
+          description: The If-Modified-Since header
+          schema:
+            type: string
+        - name: If-None-Match
+          in: header
+          description: The If-None-Match header
+          schema:
+            type: string
+        - name: If-Unmodified-Since
+          in: header
+          description: The If-Unmodified-Since header
+          schema:
+            type: string
+      responses:
+        "200":
+          description: A multipart object with one part named "configFile"
+            containing the configuration file corresponding to the section name.
+          content:
+            multipart/form-data:
+              schema:
+                type: string
+                format: binary
+        default:
+          description: The resulting error payload.
+          content: {}
+    put:
+      tags:
+        - config
+      summary: Store the named configuration file
+      description: Store the configuration file for a given name
+      operationId: putConfig
+      # roles: ROLE_USER_ADMIN, if section name is "proxyIpAccess" then also accept ROLE_CONTENT_ADMIN
+      parameters:
+        - name: sectionName
+          in: path
+          description: The name of the section for which the configuration file is
+            to be stored
+          required: true
+          schema:
+            type: string
+        - name: If-Match
+          in: header
+          description: The If-Match header
+          schema:
+            type: string
+        - name: If-Modified-Since
+          in: header
+          description: The If-Match header
+          schema:
+            type: string
+        - name: If-None-Match
+          in: header
+          description: The If-Match header
+          schema:
+            type: string
+        - name: If-Unmodified-Since
+          in: header
+          description: The If-Match header
+          schema:
+            type: string
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              required:
+                - configFile
+              type: object
+              properties:
+                configFile:
+                  type: string
+                  description: The configuration file to be stored
+                  format: binary
+        required: true
+      responses:
+        "200":
+          description: OK
+          content: {}
+        default:
+          description: The resulting error payload.
+          content: {}
+  /config/url:
+    get:
+      tags:
+        - config
+      summary: Get the configuration file for a URL
+      description: Get the configuration file stored for a given URL
+      operationId: getUrlConfig
+      # roles: ROLE_USER_ADMIN
+      parameters:
+        - name: url
+          in: query
+          description: The URL for which the configuration is requested
+          required: true
+          schema:
+            type: string
+        - name: If-Match
+          in: header
+          description: The If-Match header
+          schema:
+            type: string
+        - name: If-Modified-Since
+          in: header
+          description: The If-Modified-Since header
+          schema:
+            type: string
+        - name: If-None-Match
+          in: header
+          description: The If-None-Match header
+          schema:
+            type: string
+        - name: If-Unmodified-Since
+          in: header
+          description: The If-Unmodified-Since header
+          schema:
+            type: string
+      responses:
+        "200":
+          description: A multipart object with one part named "configFile"
+            containing the configuration file for the URL.
+          content:
+            multipart/form-data:
+              schema:
+                type: string
+                format: binary
+        default:
+          description: The resulting error payload.
+          content: {}
+  /config/loadedurls:
+    get:
+      tags:
+        - config
+      summary: Get the URLs from which the configuration was loaded
+      description: Get the URLs from which the configuration was actually loaded,
+        reflecting any failover to local copies
+      operationId: getLoadedUrlList
+      # roles: ROLE_CAUTIOUS
+      responses:
+        "200":
+          description: The URLs from which the configuration was loaded
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string
+        default:
+          description: The resulting error payload.
+          content: {}
+  /config/lastupdatetime:
+    get:
+      tags:
+        - config
+      summary: Get the timestamp when the configuration was last updated
+      description: Get the timestamp when the configuration was last updated
+      operationId: getLastUpdateTime
+      # roles: ROLE_CAUTIOUS
+      responses:
+        "200":
+          description: The timestamp when the configuration was last updated
+          content:
+            application/json:
+              schema:
+                type: string
+                format: date-time
+        default:
+          description: The resulting error payload.
+          content: {}
+  /config/reload:
+    put:
+      tags:
+        - config
+      summary: Request a configuration reload
+      description: Request that the stored configuration is reloaded
+      operationId: putConfigReload
+      # roles: ROLE_USER_ADMIN
+      responses:
+        "200":
+          description: OK
+          content: {}
+        default:
+          description: The resulting error payload.
+          content: {}
+  /config/platform:
+    get:
+      tags:
+        - config
+      summary: Get the platform configuration
+      description: Get the platform configuration
+      operationId: getPlatformConfig
+      # roles: ROLE_CAUTIOUS
+      responses:
+        "200":
+          description: The platform configuration
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/platformConfigurationWsResult'
+        default:
+          description: The resulting error payload.
+          content: {}
+  /auids:
+    post:
+      tags:
+        - aus
+      summary: Calculate an AUID for a hypothetical AU
+      description: Calculate an AUID for a hypothetical AU, given either a plugin
+        ID and an auConfig map (for traditional AUs), or a handle and an optional
+        plugin ID for NamedAUs
+      operationId: calculateAuid
+      # roles: ROLE_ANY
+      requestBody:
+        content:
+          application/x-www-form-urlencoded:
+            schema:
+              type: object
+              properties:
+                pluginId:
+                  type: string
+                  description: the plugin id
+                handle:
+                  type: string
+                  description: the handle of a NamedArchivalUnit
+                auConfig:
+                  description: The configuration information for this au (as a json
+                    map).
+      responses:
+        "200":
+          description: Map containing the resulting AUID
+          content:
+            application/json:
+              schema:
+                type: string
+            text/plain:
+              schema:
+                type: string
+        default:
+          description: The resulting error payload.
+          content: {}
+  /aus:
+    get:
+      tags:
+        - aus
+      summary: Get the configurations of all AUs
+      description: Get the configuration of all AUs
+      operationId: getAllAuConfig
+      # roles: ROLE_AU_ADMIN
+      parameters:
+        - name: limit
+          in: query
+          description: The requested maximum number of AU configurations per response
+          schema:
+            type: integer
+        - name: continuationToken
+          in: query
+          description: The continuation token of the next page of AU configurations to be returned
+          schema:
+            type: string
+      responses:
+        "200":
+          description: The requested AU configurations
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AuConfigPageInfo'
+        default:
+          description: The resulting error payload.
+          content: {}
+  /aus/{auid}:
+    get:
+      tags:
+        - aus
+      summary: Get the configuration of an AU
+      description: Get the configuration of an AU given the AU identifier
+      operationId: getAuConfig
+      # roles: ROLE_AU_ADMIN
+      parameters:
+        - name: auid
+          in: path
+          description: The identifier of the AU for which the configuration is requested
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: The configuration of the specified AU
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AuConfiguration'
+        default:
+          description: The resulting error payload.
+          content: {}
+    put:
+      tags:
+        - aus
+      summary: Store the configuration of an AU
+      description: Store the configuration of an AU given the AU identifier
+      operationId: putAuConfig
+      # roles: ROLE_AU_ADMIN
+      parameters:
+        - name: auid
+          in: path
+          description: The identifier of the AU for this configuration.
+          required: true
+          schema:
+            type: string
+      requestBody:
+        description: The Archival Unit configuration to be stored
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/AuConfiguration'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content: {}
+        default:
+          description: The resulting error payload.
+          content: {}
+      x-codegen-request-body-name: auConfiguration
+    delete:
+      tags:
+        - aus
+      summary: Delete the configuration of an AU
+      description: Delete the configuration of an AU given the AU identifier
+      operationId: deleteAuConfig
+      # roles: ROLE_AU_ADMIN
+      parameters:
+        - name: auid
+          in: path
+          description: The identifier of the AU for which the configuration is\ \ to
+            be deleted
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: The deleted configuration of the specified AU
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AuConfiguration'
+        default:
+          description: The resulting error payload.
+          content: {}
+  /ws/aus/add:
+    post:
+      tags:
+        - aus
+      summary: Add AUs
+      description: Add a group of AUs given their identifiers
+      operationId: postAus
+      # roles: ROLE_AU_ADMIN
+      requestBody:
+        description: The identifiers of the Archival Units to be added
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                type: string
+        required: true
+      responses:
+        "200":
+          description: Information about the added AUs
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/contentConfigurationResult'
+        default:
+          description: The resulting error payload.
+          content: {}
+      x-codegen-request-body-name: auIds
+  /ws/aus/deactivate:
+    put:
+      tags:
+        - aus
+      summary: Deactivate AUs
+      description: Deactivate a group of AUs given their identifiers
+      operationId: putAusDeactivate
+      # roles: ROLE_AU_ADMIN
+      requestBody:
+        description: The identifiers of the Archival Units to be deactivated
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                type: string
+        required: true
+      responses:
+        "200":
+          description: Information about the deactivated AUs
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/contentConfigurationResult'
+        default:
+          description: The resulting error payload.
+          content: {}
+      x-codegen-request-body-name: auIds
+  /ws/aus/reactivate:
+    put:
+      tags:
+        - aus
+      summary: Reactivate AUs
+      description: Reactivate a group of AUs given their identifiers
+      operationId: putAusReactivate
+      # roles: ROLE_AU_ADMIN
+      requestBody:
+        description: The identifiers of the Archival Units to be reactivated
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                type: string
+        required: true
+      responses:
+        "200":
+          description: Information about the reactivated AUs
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/contentConfigurationResult'
+        default:
+          description: The resulting error payload.
+          content: {}
+      x-codegen-request-body-name: auIds
+  /ws/aus/delete:
+    delete:
+      tags:
+        - aus
+      summary: Delete AUs
+      description: Delete a group of AUs given their identifiers
+      operationId: deleteAusDelete
+      # roles: ROLE_AU_ADMIN
+      requestBody:
+        description: The identifiers of the Archival Units to be deleted
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                type: string
+        required: true
+      responses:
+        "200":
+          description: Information about the deleted AUs
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/contentConfigurationResult'
+        default:
+          description: The resulting error payload.
+          content: {}
+      x-codegen-request-body-name: auIds
+  /aus/{auid}/mddisable:
+    put:
+      tags:
+        - aus
+      summary: Disable AU metadata extraction
+      description: Disable the metadata extraction for an AU given its identifier
+      operationId: putAusMdDisable
+      # roles: ROLE_AU_ADMIN
+      parameters:
+        - name: auid
+          in: path
+          description: The identifier of the Archival Units for which metadata extraction
+            is to be disabled
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Information about the AU for which metadata extraction has
+            been disabled
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/requestAuControlResult'
+        default:
+          description: The resulting error payload.
+          content: {}
+  /aus/{auid}/mdenable:
+    put:
+      tags:
+        - aus
+      summary: Enable AU metadata extraction
+      description: Enable the metadata extraction for an AU given its identifier
+      operationId: putAusMdEnable
+      # roles: ROLE_AU_ADMIN
+      parameters:
+        - name: auid
+          in: path
+          description: The identifier of the Archival Units for which metadata extraction
+            is to be enabled
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Information about the AU for which metadata extraction has
+            been enabled
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/requestAuControlResult'
+        default:
+          description: The resulting error payload.
+          content: {}
+  /austates/{auid}:
+    get:
+      tags:
+        - aus
+      summary: Get the state of an AU
+      description: Get the state of an AU given the AU identifier
+      operationId: getAuState
+      # roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: auid
+          in: path
+          description: The identifier of the AU for which the state is requested
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: The state of the specified AU
+          content:
+            application/json:
+              schema:
+                # Actually AuStateBean serialized as a string (see below)
+                type: string
+        default:
+          description: The resulting error payload.
+          content: {}
+    patch:
+      tags:
+        - aus
+      summary: Update the state of an AU
+      description: Update the state of an AU given the AU identifier
+      operationId: patchAuState
+      # roles: ROLE_AU_ADMIN
+      parameters:
+        - name: auid
+          in: path
+          description: The identifier of the AU for which the state is to be updated
+          required: true
+          schema:
+            type: string
+        - name: X-Lockss-Request-Cookie
+          in: header
+          description: The LOCKSS-specific request cookie header
+          schema:
+            type: string
+      requestBody:
+        description: The parts of the Archival Unit state to be updated
+        content:
+          application/json:
+            schema:
+              type: string
+        required: true
+      responses:
+        "200":
+          description: OK
+          content: {}
+        default:
+          description: The resulting error payload.
+          content: {}
+      x-codegen-request-body-name: auState
+  /auagreements/{auid}:
+    get:
+      tags:
+        - aus
+      summary: Get the poll agreements of an AU
+      description: Get the poll agreements of an AU given the AU identifier
+      operationId: getAuAgreements
+      # roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: auid
+          in: path
+          description: The identifier of the AU for which the poll agreements are
+            requested
+          required: true
+          schema:
+            # Actually AuAgreements serialized as a string, see below
+            type: string
+      responses:
+        "200":
+          description: The poll agreements of the specified AU
+          content:
+            application/json:
+              schema:
+                type: string
+        default:
+          description: The resulting error payload.
+          content: {}
+    patch:
+      tags:
+        - aus
+      summary: Update the poll agreements of an AU
+      description: Update the poll agreements of an AU given the AU identifier
+      operationId: patchAuAgreements
+      # roles: ROLE_AU_ADMIN
+      parameters:
+        - name: auid
+          in: path
+          description: The identifier of the AU for which the poll agreements are
+            to be updated
+          required: true
+          schema:
+            type: string
+        - name: X-Lockss-Request-Cookie
+          in: header
+          description: The LOCKSS-specific request cookie header
+          schema:
+            type: string
+      requestBody:
+        description: The parts of the Archival Unit poll agreements to be updated
+        content:
+          application/json:
+            schema:
+              # Actually AuAgreements serialized as a string, see below
+              type: string
+        required: true
+      responses:
+        "200":
+          description: OK
+          content: {}
+        default:
+          description: The resulting error payload.
+          content: {}
+      x-codegen-request-body-name: auAgreements
+  /aususpecturls/{auid}:
+    get:
+      tags:
+        - aus
+      summary: Get the suspect URL versions of an AU
+      description: Get the suspect URL versions of an AU given the AU identifier
+      operationId: getAuSuspectUrlVersions
+      # roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: auid
+          in: path
+          description: The identifier of the AU for which the suspect URL versions
+            are requested
+          required: true
+          schema:
+            # Actually AuSuspectUrlVersions serialized as a string; see below
+            type: string
+      responses:
+        "200":
+          description: The suspect URL versions of the specified AU
+          content:
+            application/json:
+              schema:
+                type: string
+        default:
+          description: The resulting error payload.
+          content: {}
+    put:
+      tags:
+        - aus
+      summary: Update the suspect URL versions of an AU
+      description: Update the suspect URL versions of an AU given the AU identifier
+      operationId: putAuSuspectUrlVersions
+      # roles: ROLE_AU_ADMIN
+      parameters:
+        - name: auid
+          in: path
+          description: The identifier of the AU for which the suspect URL versions
+            are to be updated
+          required: true
+          schema:
+            type: string
+        - name: X-Lockss-Request-Cookie
+          in: header
+          description: The LOCKSS-specific request cookie header
+          schema:
+            type: string
+      requestBody:
+        description: The parts of the Archival Unit suspect URL versions to be
+          updated
+        content:
+          application/json:
+            schema:
+              # Actually AuSuspectUrlVersions serialized as a string; see below
+              type: string
+        required: true
+      responses:
+        "200":
+          description: OK
+          content: {}
+        default:
+          description: The resulting error payload.
+          content: {}
+      x-codegen-request-body-name: auSuspectUrlVersions
+  /noaupeers/{auid}:
+    get:
+      tags:
+        - aus
+      summary: Get the NoAuPeerSet object of an AU
+      description: Get the NoAuPeerSet object of an AU given the AU identifier
+      operationId: getNoAuPeers
+      # roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: auid
+          in: path
+          description: The identifier of the AU for which the NoAuPeerSet object
+            is requested
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: The NoAuPeerSet object of the specified AU
+          content:
+            application/json:
+              schema:
+                # Actually DatedPeerIdSetImpl serialized as a string; see below
+                type: string
+        default:
+          description: The resulting error payload.
+          content: {}
+    put:
+      tags:
+        - aus
+      summary: Update the NoAuPeerSet object of an AU
+      description: Update the NoAuPeerSet object of an AU given the AU identifier
+      operationId: putNoAuPeers
+      # roles: ROLE_AU_ADMIN
+      parameters:
+        - name: auid
+          in: path
+          description: The identifier of the AU for which the NoAuPeerSet object
+            is to be updated
+          required: true
+          schema:
+            type: string
+        - name: X-Lockss-Request-Cookie
+          in: header
+          description: The LOCKSS-specific request cookie header
+          schema:
+            type: string
+      requestBody:
+        description: The parts of the Archival Unit NoAuPeerSet object to be updated
+        content:
+          application/json:
+            schema:
+                # Actually DatedPeerIdSetImpl serialized as a string; see below
+              type: string
+        required: true
+      responses:
+        "200":
+          description: OK
+          content: {}
+        default:
+          description: The resulting error payload.
+          content: {}
+      x-codegen-request-body-name: noAuPeerSet
+  /ws/tdbaus:
+    get:
+      tags:
+        - tdb
+      summary: Query the TDB for AUs
+      description: Query the TDB for AUs that meet a set of specified conditions
+      operationId: getTdbAus
+      # roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: tdbAuQuery
+          in: query
+          description: The query that specifies the TDB AUs to be returned
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Information about the requested TDB AUs
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/tdbAuWsResult'
+        default:
+          description: The resulting error payload.
+          content: {}
+  /ws/tdbtitles:
+    get:
+      tags:
+        - tdb
+      summary: Query the TDB for Titles
+      description: Query the TDB for Titles that meet a set of specified conditions
+      operationId: getTdbTitles
+      # roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: tdbTitleQuery
+          in: query
+          description: The query that specifies the TDB Titles to be returned
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Information about the requested TDB Titles
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/tdbTitleWsResult'
+        default:
+          description: The resulting error payload.
+          content: {}
+  /ws/tdbpublishers:
+    get:
+      tags:
+        - tdb
+      summary: Query the TDB for Publishers
+      description: Query the TDB for Publishers that meet a set of specifie conditions
+      operationId: getTdbPublishers
+      # roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: tdbPublisherQuery
+          in: query
+          description: The query that specifies the TDB Publishers to be returned
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Information about the requested TDB Publishers
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/tdbPublisherWsResult'
+        default:
+          description: The resulting error payload.
+          content: {}
+  /ws/plugins:
+    get:
+      tags:
+        - plugins
+      summary: Query for plugin properties
+      description: Query for plugins that meet a set of specified conditions
+      operationId: getPlugins
+      # roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: pluginQuery
+          in: query
+          description: The query that specifies the plugins to be returned
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Information about the requested plugins
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/pluginWsResult'
+        default:
+          description: The resulting error payload.
+          content: {}
+  /ws/auqueries:
+    get:
+      tags:
+        - aus
+      summary: Query for archival unit properties
+      description: Query for archival units that meet a set of specified conditions
+      operationId: getAuqueries
+      # roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: auQuery
+          in: query
+          description: The query that specifies the archival units to be returned
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Information about the requested archival units
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/auWsResult'
+        default:
+          description: The resulting error payload.
+          content: {}
+  /austatuses/{auid}:
+    get:
+      tags:
+        - aus
+      summary: Get the status of an AU
+      description: Get the status of an AU given the AU identifier
+      operationId: getAuStatus
+      # roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: auid
+          in: path
+          description: The identifier of the AU for which the status is requested
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: The status of the specified AU
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AuStatus'
+        default:
+          description: The resulting error payload.
+          content: {}
+  /ausubstances/{auid}:
+    put:
+      tags:
+        - aus
+      summary: Update the substance of an AU
+      description: Update the substance of an AU given the AU identifier
+      operationId: putAuSubstanceCheck
+      # roles: ROLE_AU_ADMIN
+      parameters:
+        - name: auid
+          in: path
+          description: The identifier of the AU for which the substance check is
+            requested
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: The substance check of the specified AU
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/checkSubstanceResult'
+        default:
+          description: The resulting error payload.
+          content: {}
+  /status:
+    get:
+      tags:
+        - status
+      summary: Get the status of the service
+      description: Get the status of the service
+      operationId: getStatus
+      # no credentials needed
+      responses:
+        "200":
+          description: The status of the service
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/apiStatus'
+        default:
+          description: The resulting error payload.
+          content: {}
+  /usernames:
+    get:
+      tags:
+        - users
+      summary: Get the usernames configured in the system
+      description: Get the usernames configured in the system
+      operationId: getUserAccountNames
+      # roles: ROLE_USER_ADMIN
+      responses:
+        "200":
+          description: A list of usernames configured in the system
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string
+        "401":
+          description: Unauthorized
+          content: {}
+        "500":
+          description: Internal Server Error
+          content: {}
+  /users:
+    post:
+      tags:
+        - users
+      summary: Adds user accounts to the system
+      description: Adds user accounts to the system
+      operationId: addUserAccounts
+      # roles: ROLE_USER_ADMIN
+      requestBody:
+        description: An array of user accounts to be stored
+        content:
+          application/json:
+            schema:
+              type: string
+        required: true
+      responses:
+        "200":
+          description: Successfully added user accounts
+          content:
+            application/json:
+              schema:
+                type: string
+        "401":
+          description: Unauthorized
+          content: {}
+        "500":
+          description: Internal Server Error
+          content: {}
+      x-codegen-request-body-name: userAccounts
+  /users/{username}:
+    get:
+      tags:
+        - users
+      summary: Get user account details
+      description: Get user account details
+      operationId: getUserAccount
+      # roles: ROLE_USER_ADMIN
+      parameters:
+        - name: username
+          in: path
+          description: Username
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: A JSON serialization containing details of the user account
+          content:
+            application/json:
+              schema:
+                type: string
+        "400":
+          description: Bad Request
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+        "500":
+          description: Internal Server Error
+          content: {}
+    delete:
+      tags:
+        - users
+      summary: Remove a user account from the system
+      description: Remove a user account from the system
+      operationId: removeUserAccount
+      # roles: ROLE_USER_ADMIN
+      parameters:
+        - name: username
+          in: path
+          description: Username
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Removed user account
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+        "500":
+          description: Internal Server Error
+          content: {}
+    patch:
+      tags:
+        - users
+      summary: Update properties of an existing user account
+      description: Update properties of an existing user account
+      operationId: updateUserAccount
+      # roles: ROLE_USER_ADMIN
+      parameters:
+        - name: username
+          in: path
+          description: Username
+          required: true
+          schema:
+            type: string
+        - name: X-Lockss-Request-Cookie
+          in: header
+          description: The LOCKSS-specific request cookie header
+          schema:
+            type: string
+      requestBody:
+        description: The user account details to be updated
+        content:
+          application/json:
+            schema:
+              type: string
+        required: true
+      responses:
+        "200":
+          description: Updated user account
+          content:
+            application/json:
+              schema:
+                type: string
+        "400":
+          description: Bad Request
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+        "500":
+          description: Internal Server Error
+          content: {}
+      x-codegen-request-body-name: userAccount
+  /utils/normalizeurl:
+    get:
+      tags:
+        - utils
+      summary: Normalize URL
+      description: Performs a LOCKSS URL normalization
+      operationId: normalizeUrl
+      parameters:
+        - name: url
+          in: query
+          description: URL to normalize
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: The LOCKSS normalized URL
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string
+        "400":
+          description: Bad Request
+          content:
+            text/plain:
+              schema:
+                type: string
+        "500":
+          description: Internal Server Error
+          content: {}
+components:
+  schemas:
+    AccessType:
+      # Modeled from org.lockss.state.AuState.AccessType in lockss-core
+      # Used in AuStateBean
+      type: string
+      nullable: true
+      enum:
+        - OpenAccess
+        - Subscription
+    apiStatus:
+      required:
+        - apiVersion
+        - ready
+      type: object
+      properties:
+        apiVersion:
+          type: string
+          description: The version of the API
+        componentName:
+          type: string
+          description: The name of the component
+        componentVersion:
+          type: string
+          description: The version of the component software
+        lockssVersion:
+          type: string
+          description: The version of the LOCKSS system
+        ready:
+          type: boolean
+          description: The indication of whether the service is available
+        serviceName:
+          type: string
+          description: The name of the service
+        readyTime:
+          type: integer
+          description: The time the service last became ready.
+          format: int64
+        reason:
+          type: string
+          description: The reason the service isn't ready.
+        startupStatus:
+          type: string
+          description: Enum indicating progress of plugin/AU processing at startup.
+          enum:
+            - NONE
+            - PLUGINS_CRAWLING
+            - PLUGINS_COLLECTED
+            - PLUGINS_LOADING
+            - PLUGINS_LOADED
+            - AUS_STARTING
+            - AUS_STARTED
+      description: The status information of the service
+    AuAgreements:
+      # Modeled from org.lockss.protocol.AuAgreements in lockss-core
+      # Returned by org.lockss.laaws.config.impl.AuagreementsApiServiceImpl.getAuAgreements(String) but *not* desclared by GET /auagreements/{auid}
+      # Received by org.lockss.laaws.config.impl.AuagreementsApiServiceImpl.patchAuAgreements(String, String, String) but *not* declared by PATCH /auagreements/{auid}
+      type: object
+      properties:
+        auid:
+          type: string
+          nullable: true
+        rawMap:
+          type: object
+          nullable: true
+          additionalProperties:
+            $ref: '#/components/schemas/PeerAgreements'
+    AuConfiguration:
+      # Modeled from org.lockss.config.AuConfiguration in lockss-core
+      # Returned by org.lockss.laaws.config.impl.AusApiServiceImpl.getAuConfig(String) and declared in GET /aus/{auid}
+      # Returned by org.lockss.laaws.config.impl.AusApiServiceImpl.getAllAuConfig() (Collection) and declared in GET /aus (array)
+      description: The encapsulation of an Archival Unit configuration
+      required:
+        - auConfig
+        - auId
+      type: object
+      properties:
+        auId:
+          description: The identifier of the Archival Unit
+          type: string
+        auConfig:
+          description: The map of Archival Unit configuration items
+          type: object
+          additionalProperties:
+            type: string
+            description: The value of the configuration for the key
+    AuConfigPageInfo:
+      type: object
+      required:
+        - auConfigs
+        - pageInfo
+      properties:
+        auConfigs:
+          title: AU Configurations
+          description: The AU configurations included in the page
+          type: array
+          items:
+            $ref: '#/components/schemas/AuConfiguration'
+          nullable: false
+        pageInfo:
+          title: Page Information
+          description: Information about the page
+          $ref: '#/components/schemas/PageInfo'
+          nullable: false
+    AuStateBean:
+      # Modeled from org.lockss.state.AuStateBean in lockss-core
+      # Returned by org.lockss.laaws.config.impl.AustatesApiServiceImpl.getAuState(String) but *not* declared in GET /austates/{auid}
+      type: object
+      properties:
+        auCreationTime:
+          type: integer
+          format: int64
+        lastCrawlTime:
+          type: integer
+          format: int64
+        lastCrawlAttempt:
+          type: integer
+          format: int64
+        lastCrawlResultMsg:
+          type: string
+          nullable: true
+        lastCrawlResult:
+          type: integer
+          format: int32
+        lastDeepCrawlTime:
+          type: integer
+          format: int64
+        lastDeepCrawlAttempt:
+          type: integer
+          format: int64
+        lastDeepCrawlResultMsg:
+          type: string
+          nullable: true
+        lastDeepCrawlResult:
+          type: integer
+          format: int32
+        lastDeepCrawlDepth:
+          type: integer
+          format: int32
+        lastTopLevelPollTime:
+          type: integer
+          format: int64
+        lastPollStart:
+          type: integer
+          format: int64
+        lastPollResult:
+          type: integer
+          format: int32
+        pollDuration:
+          type: integer
+          format: int64
+        averageHashDuration:
+          type: integer
+          format: int64
+        clockssSubscriptionStatus:
+          type: integer
+          format: int32
+        v3Agreement:
+          type: number
+          format: double
+        highestV3Agreement:
+          type: number
+          format: double
+        accessType:
+          $ref: '#/components/schemas/AccessType'
+        hasSubstance:
+          $ref: '#/components/schemas/SubstanceCheckerState'
+        substanceVersion:
+          type: string
+          nullable: true
+        metadataVersion:
+          type: string
+          nullable: true
+        lastMetadataIndex:
+          type: integer
+          format: int64
+        lastContentChange:
+          type: integer
+          format: int64
+        lastPoPPoll:
+          type: integer
+          format: int64
+        lastPoPPollResult:
+          type: integer
+          format: int32
+        lastLocalHashScan:
+          type: integer
+          format: int64
+        numAgreePeersLastPoR:
+          type: integer
+          format: int32
+        numWillingRepairers:
+          type: integer
+          format: int32
+        numCurrentSuspectVersions:
+          type: integer
+          format: int32
+        cdnStems:
+          type: array
+          nullable: true
+          items:
+            type: string
+        isMetadataExtractionEnabled:
+          type: boolean
+        auId:
+          type: string
+          nullable: true
+    AuStatus:
+      # Modeled from org.lockss.ws.entities.AuStatus in lockss-util-entities
+      # Returned by org.lockss.laaws.config.impl.AustatusesApiServiceImpl.getAuStatus(String) and declared in GET /austatuses/{auid} 
+      description: The status of an archival unit
+      type: object
+      properties:
+        volume:
+          type: string
+          nullable: true
+        journalTitle:
+          type: string
+          nullable: true
+        pluginName:
+          type: string
+          nullable: true
+        year:
+          type: string
+          nullable: true
+        accessType:
+          type: string
+          nullable: true
+        contentSize:
+          type: integer
+          format: int64
+          nullable: true
+        diskUsage:
+          type: integer
+          format: int64
+          nullable: true
+        repository:
+          type: string
+          nullable: true
+        status:
+          type: string
+          nullable: true
+        recentPollAgreement:
+          type: number
+          format: double
+          nullable: true
+        publishingPlatform:
+          type: string
+          nullable: true
+        publisher:
+          type: string
+          nullable: true
+        availableFromPublisher:
+          type: boolean
+          nullable: true
+        substanceState:
+          type: string
+          nullable: true
+        creationTime:
+          type: integer
+          format: int64
+          nullable: true
+        crawlProxy:
+          type: string
+          nullable: true
+        crawlWindow:
+          type: string
+          nullable: true
+        crawlPool:
+          type: string
+          nullable: true
+        lastCompletedCrawl:
+          type: integer
+          format: int64
+          nullable: true
+        lastCrawl:
+          type: integer
+          format: int64
+          nullable: true
+        lastCrawlResult:
+          type: string
+          nullable: true
+        lastCompletedDeepCrawl:
+          type: integer
+          format: int64
+          nullable: true
+        lastDeepCrawl:
+          type: integer
+          format: int64
+          nullable: true
+        lastDeepCrawlResult:
+          type: string
+          nullable: true
+        lastCompletedDeepCrawlDepth:
+          type: integer
+          format: int32
+        lastMetadataIndex:
+          type: integer
+          format: int64
+          nullable: true
+        lastCompletedPoll:
+          type: integer
+          format: int64
+          nullable: true
+        lastPoll:
+          type: integer
+          format: int64
+          nullable: true
+        lastPollResult:
+          type: string
+          nullable: true
+        currentlyCrawling:
+          type: boolean
+          nullable: true
+        currentlyPolling:
+          type: boolean
+          nullable: true
+        subscriptionStatus:
+          type: string
+          nullable: true
+        provider:
+          type: string
+          nullable: true
+    AuSuspectUrlVersions:
+      # Modeled from org.lockss.state.AuSuspectUrlVersions in lockss-core
+      # Returned by org.lockss.laaws.config.impl.AususpecturlsApiServiceImpl.getAuSuspectUrlVersions(String) but *not* declared in GET /aususpecturls/{auid}
+      # Received by org.lockss.laaws.config.impl.AususpecturlsApiServiceImpl.putAuSuspectUrlVersions(String, String, String) but *not* declared in PUT /aususpecturls/{auid}
+      type: object
+      properties:
+        auid:
+          type: string
+          nullable: true
+        suspectVersions:
+          type: array
+          nullable: true
+          items:
+            $ref: '#/components/schemas/SuspectUrlVersion'
+    auWsResult:
+      required:
+        - auId
+      type: object
+      properties:
+        auId:
+          type: string
+          description: The identifier of the archival unit
+      description: The properties of an archival unit
+    checkSubstanceResult:
+      required:
+        - errorMessage
+        - id
+        - newState
+        - oldState
+      type: object
+      properties:
+        id:
+          type: string
+          description: The identifier of the archival unit
+        oldState:
+          $ref: '#/components/schemas/SubstanceCheckerState'
+        newState:
+          $ref: '#/components/schemas/SubstanceCheckerState'
+        errorMessage:
+          type: string
+          description: The error message as a result of the operation
+      description: The status of an archival unit
+    contentConfigurationResult:
+      required:
+        - auId
+        - isSuccess
+        - message
+        - name
+      type: object
+      properties:
+        auId:
+          type: string
+          description: The identifier of the Archival Unit
+        name:
+          type: string
+          description: The name of the Archival Unit
+        isSuccess:
+          type: boolean
+          description: An indication of whether the AU was successfully added or not
+        message:
+          type: string
+          description: A descriptive message regarding the result of the operation
+      description: The encapsulation of the result of adding an Archival Unit
+    DatedPeerIdSetImpl:
+      # Modeled from org.lockss.protocol.DatedPeerIdSetImpl in lockss-core
+      # Returned by org.lockss.laaws.config.impl.NoaupeersApiServiceImpl.getNoAuPeers(String) but *not* declared in GET /noaupeers/{auid}
+      # Received by org.lockss.laaws.config.impl.NoaupeersApiServiceImpl.putNoAuPeers(String, String, String) but *not* declared in PUT /noaupeers/{auid}
+      type: object
+      properties:
+        auid:
+          type: string
+          nullable: true
+        rawSet:
+          type: array
+          nullable: true
+          items:
+            type: string
+        date:
+          type: integer
+          format: int64
+    HashResult:
+      # Modeled from org.lockss.hasher.HashResult in lockss-core
+      # Used by SuspectUrlVersion
+      type: object
+      properties:
+        bytes:
+          type: string
+          # 'format' should be 'byte' if base64-encoded
+          format: binary
+          nullable: true
+        algorithm:
+          type: string
+          nullable: true
+    PeerAgreement:
+      # Modeled from org.lockss.protocol.PeerAgreement in lockss-core
+      # Used in PeerAgreements
+      type: object
+      properties:
+        percentAgreement:
+          type: number
+          format: float
+        percentAgreementTime:
+          type: integer
+          format: int64
+        highestPercentAgreement:
+          type: number
+          format: float
+        highestPercentAgreementTime:
+          type: integer
+          format: int64
+    PeerAgreements:
+      # Modeled from org.lockss.protocol.PeerAgreements in lockss-core
+      # Used in AuAgreements
+      type: object
+      properties:
+        id:
+          type: string
+          nullable: true
+        map:
+          type: object
+          nullable: true
+          additionalProperties:
+            $ref: '#/components/schemas/PeerAgreement'
+    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
+    platformConfigurationWsResult:
+      description: The configuration of the platform
+      type: object
+      properties:
+        hostName:
+          type: string
+          nullable: true
+        ipAddress:
+          type: string
+          nullable: true
+        groups:
+          type: array
+          nullable: true
+          items:
+            type: string
+        project:
+          type: string
+          nullable: true
+        v3Identity:
+          type: string
+          nullable: true
+        mailRelay:
+          type: string
+          nullable: true
+        adminEmail:
+          type: string
+          nullable: true
+        disks:
+          type: array
+          nullable: true
+          items:
+            type: string
+        currentTime:
+          type: integer
+          format: int64
+          nullable: true
+        uptime:
+          type: integer
+          format: int64
+          nullable: true
+        daemonVersion:
+          type: object
+          nullable: true
+          properties:
+            fullVersion:
+              type: string
+              nullable: true
+            majorVersion:
+              type: integer
+              format: int32
+              nullable: true
+            minorVersion:
+              type: integer
+              format: int32
+              nullable: true
+            buildVersion:
+              type: integer
+              format: int32
+              nullable: true
+        javaVersion:
+          type: object
+          nullable: true
+          properties:
+            version:
+              type: string
+              nullable: true
+            specificationVersion:
+              type: string
+              nullable: true
+            runtimeVersion:
+              type: string
+              nullable: true
+            runtimeName:
+              type: string
+              nullable: true
+        platform:
+          type: object
+          properties:
+            name:
+              type: string
+              nullable: true
+            version:
+              type: string
+              nullable: true
+            suffix:
+              type: string
+              nullable: true
+        currentWorkingDirectory:
+          type: string
+          nullable: true
+        properties:
+          type: array
+          nullable: true
+          items:
+            type: string
+        buildHost:
+          type: string
+          nullable: true
+        buildTimestamp:
+          type: integer
+          format: int64
+          nullable: true
+    pluginWsResult:
+      required:
+        - auCount
+        - definition
+        - name
+        - pluginId
+        - publishingPlatform
+        - registry
+        - type
+        - url
+        - version
+      type: object
+      properties:
+        pluginId:
+          type: string
+          description: The identifier of the plugin
+        name:
+          type: string
+          description: The name of the plugin
+        version:
+          type: string
+          description: The version of the plugin
+        type:
+          type: string
+          description: The type of the plugin
+        definition:
+          type: object
+          additionalProperties:
+            type: string
+            description: The value of the property for the key
+          description: The map of plugin definition properties
+        registry:
+          type: string
+          description: The registry of the plugin
+        url:
+          type: string
+          description: The URL of the plugin
+        auCount:
+          type: integer
+          description: The count of Archival Units linked to the plugin
+        publishingPlatform:
+          type: string
+          description: The publishing platform of the plugin
+      description: The properties of a plugin
+    requestAuControlResult:
+      required:
+        - errorMessage
+        - id
+        - success
+      type: object
+      properties:
+        id:
+          type: string
+          description: The identifier of the archival unit
+        success:
+          type: boolean
+          description: An indication of whether the result is successful
+        errorMessage:
+          type: string
+          description: The error message as a result of the operation
+      description: The result of an archival unit generic control request
+    SubstanceCheckerState:
+      # Modeled from org.lockss.state.SubstanceChecker.State in lockss-core
+      # Used in AuStateBean and checkSubstanceResult
+      type: string
+      nullable: true
+      enum:
+        - Unknown
+        - Yes
+        - No
+    SuspectUrlVersion:
+      # Modeled from org.lockss.state.AuSuspectUrlVersions.SuspectUrlVersion in lockss-core
+      # Used by AuSuspectUrlVersions
+      type: object
+      properties:
+        url:
+          type: string
+          nullable: true
+        version:
+          type: integer
+          format: int32
+        created:
+          type: integer
+          format: int64
+        computedHash:
+          $ref: '#/components/schemas/HashResult'
+        storedHash:
+          $ref: '#/components/schemas/HashResult'
+    tdbAuWsResult:
+      type: object
+      properties:
+        auId:
+          type: string
+          description: The identifier of the Archival Unit
+        name:
+          type: string
+          description: The name of the Archival Unit
+        pluginName:
+          type: string
+          description: The name of the Archival Unit plugin
+        tdbTitle:
+          $ref: '#/components/schemas/tdbTitleWsResult'
+        tdbPublisher:
+          $ref: '#/components/schemas/tdbPublisherWsResult'
+        down:
+          type: boolean
+          description: An indication of whether the AU is marked as down or not
+        active:
+          type: boolean
+          description: An indication of whether the AU is active or not
+        params:
+          type: object
+          additionalProperties:
+            type: string
+            description: The value of the parameter for the key
+          description: The map of Archival Unit parameters
+        attrs:
+          type: object
+          additionalProperties:
+            type: string
+            description: The value of the attribute for the key
+          description: The map of Archival Unit attributes
+        props:
+          type: object
+          additionalProperties:
+            type: string
+            description: The value of the property for the key
+          description: The map of Archival Unit properties
+      description: The properties of a TDB Archival Unit
+    tdbPublisherWsResult:
+      required:
+        - name
+      type: object
+      properties:
+        name:
+          type: string
+          description: The name of the TDB Publisher
+      description: The properties of a TDB Publisher
+    tdbTitleWsResult:
+      type: object
+      properties:
+        name:
+          type: string
+          description: The name of the TDB Title
+        tdbPublisher:
+          $ref: '#/components/schemas/tdbPublisherWsResult'
+        id:
+          type: string
+          description: The identifier of the TDB Title
+        proprietaryid:
+          type: string
+          description: The proprietary identifier of the TDB Title
+        proprietaryids:
+          type: array
+          description: The proprietary identifiers of the TDB Title
+          items:
+            type: string
+        publicationtype:
+          type: string
+          description: The publication type of the TDB Title
+        issn:
+          type: string
+          description: The ISSN of the TDB Title
+        issnl:
+          type: string
+          description: The ISSNL of the TDB Title
+        eissn:
+          type: string
+          description: The eISSN of the TDB Title
+        printissn:
+          type: string
+          description: The print ISSN of the TDB Title
+        issns:
+          type: array
+          description: The ISSNs of the TDB Title
+          items:
+            type: string
+      description: The properties of a TDB Title
+  securitySchemes:
+    basicAuth:
+      type: http
+      description: HTTP Basic Authentication. Works over HTTP and HTTPS.
+      scheme: basic