openapi: 3.2.0
info:
  title: Folio Settings API
  version: '1.0'
  description: 'Operations tagged Settings across 11 of this provider''s published API definitions: folio-mod-agreements-openapi.json, folio-mod-consortia-keycloak-sharing-settings-openapi.json, folio-mod-licenses-openapi.json, folio-mod-oa-openapi.json, folio-mod-settings-openapi.json, folio-mod-agreements-openapi.yml, folio-mod-consortia-keycloak-sharing-settings-openapi.yml, folio-mod-consortia-sharing-settings-openapi.yml, folio-mod-licenses-openapi.yml, folio-mod-oa-openapi.yml…'
servers:
- url: https://folio-snapshot-okapi.dev.folio.org
- url: https://folio-snapshot-2-okapi.dev.folio.org
- url: https://folio-etesting-snapshot-kong.ci.folio.org
- url: /consortia/{consortiumId}/sharing
tags:
- name: Settings
paths:
  /erm/settings/appSettings:
    description: Supports search and creation of application settings. AppSetting is a generic key/value settings record from the shared web-toolkit library, not specific to this module.
    parameters:
    - $ref: '#/components/parameters/x-okapi-tenant'
    get:
      tags:
      - Settings
      summary: Get a set of application setting records
      operationId: getAppSettings
      parameters:
      - $ref: '#/components/parameters/filters'
      - $ref: '#/components/parameters/match'
      - $ref: '#/components/parameters/term'
      - $ref: '#/components/parameters/sort'
      - $ref: '#/components/parameters/stats'
      - $ref: '#/components/parameters/perPage'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/page'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/AppSettingResults'
                - $ref: '#/components/schemas/AppSettingResultsArray'
        '400':
          description: Bad request error
        '403':
          description: Forbidden
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
      security:
      - accessToken: []
      - okapiToken: []
    post:
      tags:
      - Settings
      summary: Create application setting record
      operationId: postAppSetting
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppSetting'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppSetting'
        '400':
          description: Bad request error
        '403':
          description: Forbidden
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationError'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
      security:
      - accessToken: []
      - okapiToken: []
    servers:
    - url: https://folio-snapshot-okapi.dev.folio.org
    - url: https://folio-snapshot-2-okapi.dev.folio.org
    - url: https://folio-etesting-snapshot-kong.ci.folio.org
  /erm/settings/appSettings/{settingId}:
    parameters:
    - $ref: '#/components/parameters/x-okapi-tenant'
    - $ref: '#/components/parameters/settingId'
    get:
      tags:
      - Settings
      summary: Get a specified application setting record
      operationId: getAppSetting
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppSetting'
        '400':
          description: Bad request error
        '403':
          description: Forbidden
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpError'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
      security:
      - accessToken: []
      - okapiToken: []
    put:
      tags:
      - Settings
      summary: Update application setting record
      operationId: putAppSetting
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppSetting'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppSetting'
        '400':
          description: Bad request error
        '403':
          description: Forbidden
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpError'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationError'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
      security:
      - accessToken: []
      - okapiToken: []
    delete:
      tags:
      - Settings
      summary: Delete a specified application setting record
      operationId: deleteAppSetting
      responses:
        '204':
          description: No content
        '400':
          description: Bad request error
        '403':
          description: Forbidden
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpError'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
      security:
      - accessToken: []
      - okapiToken: []
    servers:
    - url: https://folio-snapshot-okapi.dev.folio.org
    - url: https://folio-snapshot-2-okapi.dev.folio.org
    - url: https://folio-etesting-snapshot-kong.ci.folio.org
  /settings:
    post:
      summary: start setting sharing
      operationId: startSharingSetting
      parameters:
      - $ref: '#/components/parameters/consortiumId'
      requestBody:
        $ref: '#/components/requestBodies/SharingSettingBody'
      responses:
        '201':
          $ref: '#/components/responses/SharingSettingResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
      tags:
      - Settings
    servers:
    - url: /consortia/{consortiumId}/sharing
  /settings/{settingId}:
    delete:
      summary: delete sharing setting
      operationId: deleteSharingSetting
      parameters:
      - $ref: '#/components/parameters/consortiumId'
      - $ref: '#/components/parameters/settingId_2'
      requestBody:
        $ref: '#/components/requestBodies/SharingSettingBody'
      responses:
        '200':
          $ref: '#/components/responses/SharingSettingDeleteResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
      tags:
      - Settings
    servers:
    - url: /consortia/{consortiumId}/sharing
  /licenses/settings/appSettings:
    description: Supports search and creation of application settings. AppSetting is a generic key/value settings record from the shared web-toolkit library, not specific to this module.
    parameters:
    - $ref: '#/components/parameters/x-okapi-tenant'
    get:
      tags:
      - Settings
      summary: Get a set of application setting records
      operationId: getLicensesSettingsAppSettings
      parameters:
      - $ref: '#/components/parameters/filters'
      - $ref: '#/components/parameters/match'
      - $ref: '#/components/parameters/term'
      - $ref: '#/components/parameters/sort'
      - $ref: '#/components/parameters/stats'
      - $ref: '#/components/parameters/perPage'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/page'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/AppSettingResults'
                - $ref: '#/components/schemas/AppSettingResultsArray'
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
      security:
      - accessToken: []
      - okapiToken: []
      x-operation-id-source: normalized
      x-operation-id-original: getAppSettings
    post:
      tags:
      - Settings
      summary: Create application setting record
      operationId: postLicensesSettingsAppSettings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppSetting'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppSetting'
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
      security:
      - accessToken: []
      - okapiToken: []
      x-operation-id-source: normalized
      x-operation-id-original: postAppSetting
    servers:
    - url: https://folio-snapshot-okapi.dev.folio.org
    - url: https://folio-snapshot-2-okapi.dev.folio.org
    - url: https://folio-etesting-snapshot-kong.ci.folio.org
  /licenses/settings/appSettings/{id}:
    parameters:
    - $ref: '#/components/parameters/x-okapi-tenant'
    - $ref: '#/components/parameters/appSettingId'
    get:
      tags:
      - Settings
      summary: Get a specified application setting record
      operationId: getLicensesSettingsAppSettingsById
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppSetting'
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
      security:
      - accessToken: []
      - okapiToken: []
      x-operation-id-source: normalized
      x-operation-id-original: getAppSetting
    put:
      tags:
      - Settings
      summary: Update application setting record
      operationId: putLicensesSettingsAppSettingsById
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppSetting'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppSetting'
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found error
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
      security:
      - accessToken: []
      - okapiToken: []
      x-operation-id-source: normalized
      x-operation-id-original: putAppSetting
    delete:
      tags:
      - Settings
      summary: Delete a specified application setting record
      operationId: deleteLicensesSettingsAppSettingsById
      responses:
        '204':
          description: No content
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
      security:
      - accessToken: []
      - okapiToken: []
      x-operation-id-source: normalized
      x-operation-id-original: deleteAppSetting
    servers:
    - url: https://folio-snapshot-okapi.dev.folio.org
    - url: https://folio-snapshot-2-okapi.dev.folio.org
    - url: https://folio-etesting-snapshot-kong.ci.folio.org
  /oa/settings/appSettings:
    description: Supports search and creation of application settings. `AppSetting` is a generic key/value settings record from the shared web-toolkit library, not specific to this module.
    parameters:
    - $ref: '#/components/parameters/x-okapi-tenant'
    get:
      tags:
      - Settings
      summary: Get a set of application setting records
      operationId: getOaSettingsAppSettings
      parameters:
      - $ref: '#/components/parameters/filters'
      - $ref: '#/components/parameters/match'
      - $ref: '#/components/parameters/term'
      - $ref: '#/components/parameters/sort'
      - $ref: '#/components/parameters/stats'
      - $ref: '#/components/parameters/perPage'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/page'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/AppSettingResults'
                - $ref: '#/components/schemas/AppSettingResultsArray'
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '500':
          description: Internal server error
      security:
      - accessToken: []
      - okapiToken: []
      x-operation-id-source: normalized
      x-operation-id-original: getAppSettings
    post:
      tags:
      - Settings
      summary: Create application setting record
      operationId: postOaSettingsAppSettings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppSetting'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppSetting'
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '500':
          description: Internal server error
      security:
      - accessToken: []
      - okapiToken: []
      x-operation-id-source: normalized
      x-operation-id-original: postAppSetting
    servers:
    - url: https://folio-snapshot-okapi.dev.folio.org
    - url: https://folio-snapshot-2-okapi.dev.folio.org
    - url: https://folio-etesting-snapshot-kong.ci.folio.org
  /oa/settings/appSettings/{id}:
    parameters:
    - $ref: '#/components/parameters/x-okapi-tenant'
    - $ref: '#/components/parameters/appSettingId'
    get:
      tags:
      - Settings
      summary: Get a specified application setting record
      operationId: getOaSettingsAppSettingsById
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppSetting'
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpringBootErrorResponse'
        '500':
          description: Internal server error
      security:
      - accessToken: []
      - okapiToken: []
      x-operation-id-source: normalized
      x-operation-id-original: getAppSetting
    put:
      tags:
      - Settings
      summary: Update application setting record
      operationId: putOaSettingsAppSettingsById
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppSetting'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppSetting'
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpringBootErrorResponse'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '500':
          description: Internal server error
      security:
      - accessToken: []
      - okapiToken: []
      x-operation-id-source: normalized
      x-operation-id-original: putAppSetting
    delete:
      tags:
      - Settings
      summary: Delete a specified application setting record
      operationId: deleteOaSettingsAppSettingsById
      responses:
        '204':
          description: No content
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpringBootErrorResponse'
        '500':
          description: Internal server error
      security:
      - accessToken: []
      - okapiToken: []
      x-operation-id-source: normalized
      x-operation-id-original: deleteAppSetting
    servers:
    - url: https://folio-snapshot-okapi.dev.folio.org
    - url: https://folio-snapshot-2-okapi.dev.folio.org
    - url: https://folio-etesting-snapshot-kong.ci.folio.org
  /settings/entries:
    parameters:
    - $ref: '#/components/parameters/okapi-permissions'
    - $ref: '#/components/parameters/okapi-tenant'
    - $ref: '#/components/parameters/okapi-token'
    - $ref: '#/components/parameters/okapi-url'
    - $ref: '#/components/parameters/okapi-user'
    - $ref: '#/components/parameters/limit'
    - $ref: '#/components/parameters/offset_2'
    - $ref: '#/components/parameters/query'
    get:
      description: Get settings with optional CQL query. If X-Okapi-Permissions includes mod-settings.global.read.SCOPE then settings without a userId are returned. If X-Okapi-Permissions includes mod-settings.users.read.SCOPE then settings with a userId are returned. If X-Okapi-Permissions includes mod-settings.owner.read.SCOPE then settings with userId = current-user are returned.
      operationId: getSettings
      responses:
        '200':
          description: Setting entries
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/entries'
        '400':
          $ref: '#/components/responses/trait_400'
        '404':
          $ref: '#/components/responses/trait_404'
        '500':
          $ref: '#/components/responses/trait_500'
      tags:
      - Settings
      summary: Get settings
      x-summary-source: derived
    post:
      description: Create setting entry. If X-Okapi-Permissions includes mod-settings.global.write.SCOPE, then a setting without a userId may be created. If X-Okapi-Permissions includes mod-settings.users.write.SCOPE, then a setting with a userId may be created. If X-Okapi-Permissions includes mod-settings.owner.write.SCOPE, then a setting with userId = current-user may be created.
      operationId: postSetting
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/entry'
      responses:
        '204':
          description: Setting created
        '400':
          $ref: '#/components/responses/trait_400'
        '403':
          $ref: '#/components/responses/trait_403'
        '413':
          $ref: '#/components/responses/trait_413'
        '500':
          $ref: '#/components/responses/trait_500'
      tags:
      - Settings
      summary: Post setting
      x-summary-source: derived
  /settings/entries/{id}:
    parameters:
    - $ref: '#/components/parameters/okapi-permissions'
    - $ref: '#/components/parameters/okapi-tenant'
    - $ref: '#/components/parameters/okapi-token'
    - $ref: '#/components/parameters/okapi-url'
    - $ref: '#/components/parameters/okapi-user'
    - in: path
      name: id
      required: true
      description: Settings entry identifier
      schema:
        type: string
        format: uuid
    get:
      description: Get setting. If X-Okapi-Permissions includes mod-settings.global.read.SCOPE, then a setting without a userId may be retrieved. If X-Okapi-Permissions includes mod-settings.users.read.SCOPE, then a setting with a userId may be retrieved. If X-Okapi-Permissions includes mod-settings.owner.read.SCOPE, then a setting with userId = current-user may be retrieved.
      operationId: getSetting
      responses:
        '200':
          description: Configuration entry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/entry'
        '400':
          $ref: '#/components/responses/trait_400'
        '403':
          $ref: '#/components/responses/trait_403'
        '404':
          $ref: '#/components/responses/trait_404'
        '500':
          $ref: '#/components/responses/trait_500'
      tags:
      - Settings
      summary: Get setting
      x-summary-source: derived
    put:
      description: Update setting. If X-Okapi-Permissions includes mod-settings.global.write.SCOPE, then a setting without a userId may be updated. If X-Okapi-Permissions includes mod-settings.users.write.SCOPE, then a setting with a userId may be updated. If X-Okapi-Permissions includes mod-settings.owner.write.SCOPE, then a setting with userId = current-user may be updated.
      operationId: putSetting
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/entry'
      responses:
        '204':
          description: Setting updated
        '400':
          $ref: '#/components/responses/trait_400'
        '403':
          $ref: '#/components/responses/trait_403'
        '404':
          $ref: '#/components/responses/trait_404'
        '413':
          $ref: '#/components/responses/trait_413'
        '500':
          $ref: '#/components/responses/trait_500'
      tags:
      - Settings
      summary: Put setting
      x-summary-source: derived
    delete:
      description: Delete setting. If X-Okapi-Permissions includes mod-settings.global.write.SCOPE, then a setting without a userId may be deleted. If X-Okapi-Permissions includes mod-settings.users.write.SCOPE, then a setting with a userId may be deleted. If X-Okapi-Permissions includes mod-settings.owner.write.SCOPE, then a setting with userId = current-user may be deleted.
      operationId: deleteSetting
      responses:
        '204':
          description: Setting deleted
        '400':
          $ref: '#/components/responses/trait_400'
        '404':
          $ref: '#/components/responses/trait_404'
        '500':
          $ref: '#/components/responses/trait_500'
      tags:
      - Settings
      summary: Delete setting
      x-summary-source: derived
  /settings/upload:
    parameters:
    - $ref: '#/components/parameters/okapi-permissions'
    - $ref: '#/components/parameters/okapi-tenant'
    - $ref: '#/components/parameters/okapi-token'
    - $ref: '#/components/parameters/okapi-url'
    - $ref: '#/components/parameters/okapi-user'
    put:
      description: Upload settings. The entries are inserted or updated depending on whether key, scope, userId already. Each entry gets a unique identifier assigned if it's a new setting. The id must not be supplied. If X-Okapi-Permissions includes mod-settings.global.write.SCOPE, then a setting without a userId may be created/updated. If X-Okapi-Permissions includes mod-settings.users.write.SCOPE, then a setting with a userId may be created/updated. If X-Okapi-Permissions includes mod-settings.owner.write.SCOPE, then a setting with userId = current-user may be created/updated.
      operationId: uploadSettings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/uploadRequest'
      responses:
        '200':
          description: Settings uploaded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/uploadResponse'
        '400':
          $ref: '#/components/responses/trait_400'
        '403':
          $ref: '#/components/responses/trait_403'
        '500':
          $ref: '#/components/responses/trait_500'
      tags:
      - Settings
      summary: Upload settings
      x-summary-source: derived
components:
  parameters:
    offset:
      in: query
      name: offset
      required: false
      schema:
        type: integer
    perPage:
      in: query
      name: perPage
      required: false
      schema:
        type: integer
    settingId:
      in: path
      name: settingId
      description: Identifier for an application setting
      required: true
      schema:
        type: string
    page:
      in: query
      name: page
      required: false
      schema:
        type: integer
    filters:
      in: query
      name: filters
      required: false
      schema:
        type: string
    stats:
      in: query
      name: stats
      required: false
      schema:
        type: boolean
    x-okapi-tenant:
      in: header
      name: x-okapi-tenant
      required: true
      schema:
        type: string
    match:
      in: query
      name: match
      required: false
      schema:
        type: string
    term:
      in: query
      name: term
      required: false
      schema:
        type: string
    sort:
      in: query
      name: sort
      required: false
      schema:
        type: string
    consortiumId:
      in: path
      name: consortiumId
      schema:
        $ref: '#/components/schemas/uuid'
      required: true
      description: The ID of consortium
    settingId_2:
      in: path
      name: settingId
      schema:
        $ref: '#/components/schemas/uuid'
      required: true
      description: The ID of setting
    appSettingId:
      in: path
      name: id
      description: Identifier for an application setting
      required: true
      schema:
        type: string
    offset_2:
      in: query
      name: offset
      description: Skip over number of elements (default is first element)
      required: false
      schema:
        type: integer
        default: 0
        minimum: 0
    okapi-permissions:
      in: header
      name: X-Okapi-Permissions
      description: A JSON array with client permissions
      required: true
      schema:
        type: string
    okapi-tenant:
      in: header
      name: X-Okapi-Tenant
      description: Okapi Tenant
      required: true
      schema:
        type: string
        pattern: ^[_a-z][_a-z0-9]*$
    okapi-url:
      in: header
      name: X-Okapi-Url
      description: Okapi URL
      required: false
      schema:
        type: string
    query:
      in: query
      name: query
      description: CQL query
      required: false
      schema:
        type: string
    okapi-user:
      in: header
      name: X-Okapi-User-Id
      description: Okapi user identifier
      required: false
      schema:
        type: string
    okapi-token:
      in: header
      name: X-Okapi-Token
      description: Okapi Token
      required: false
      schema:
        type: string
    limit:
      in: query
      name: limit
      description: Limit the number of elements returned in the response
      required: false
      schema:
        type: integer
        default: 10
        minimum: 0
    settingId_3:
      in: path
      name: settingId
      schema:
        $ref: '#/components/schemas/uuid'
      required: true
      description: The ID of setting
    settingId_4:
      in: path
      name: settingId
      schema:
        $ref: '#/components/schemas/uuid'
      required: true
      description: The ID of setting
    offset_3:
      in: query
      name: offset
      description: Skip over number of elements (default is first element)
      required: false
      schema:
        type: integer
        default: 0
        minimum: 0
  schemas:
    HttpError:
      type: object
      properties:
        message:
          type: string
        error:
          type: integer
    AppSettingResults:
      type: object
      required:
      - results
      allOf:
      - $ref: '#/components/schemas/ResultsMeta'
      - type: object
      - properties:
          results:
            $ref: '#/components/schemas/AppSettingResultsArray'
    GrailsErrorResponse:
      type: object
      description: Error-handler body for an uncaught exception raised during request processing. `exception` and `stackTrace` usually suppressed in production systems
      required:
      - error
      - timestamp
      - message
      properties:
        error:
          type: integer
          description: HTTP status code
        timestamp:
          type: string
          format: date-time
        message:
          type: string
        exception:
          type: string
          description: Exception class and message.
        stackTrace:
          type: array
          items:
            type: string
    AppSettingResultsArray:
      type: array
      items:
        $ref: '#/components/schemas/AppSetting'
    ApplicationError:
      type: object
      properties:
        total:
          type: integer
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              i18n_code:
                type: string
              message:
                type: string
              object:
                type: string
    ResultsMeta:
      type: object
      properties:
        meta:
          type: object
        page:
          type: integer
        pageSize:
          type: integer
        total:
          type: integer
        totalPages:
          type: integer
        totalRecords:
          type: integer
    AppSetting:
      type: object
      required:
      - id
      - key
      properties:
        id:
          type: string
          readOnly: true
        section:
          type: string
        key:
          type: string
        settingType:
          type: string
        vocab:
          type: string
        defValue:
          type: string
        value:
          type: string
        hidden:
          type: boolean
          description: If true, this setting is excluded from filter/search results but is otherwise still retrievable and modifiable normally.
    SharingSettingRequest:
      description: A JSON schema for the Sharing settings object
      type: object
      properties:
        settingId:
          description: id of sharing setting record
          type: string
          format: uuid
        url:
          description: URL for publishing requests for consortia tenants
          type: string
        payload:
          description: Http request body
          type: object
      additionalProperties: false
      required:
      - settingId
      - url
    Error:
      description: An error
      type: object
      properties:
        message:
          type: string
          minLength: 1
          description: Error message text
        type:
          type: string
          description: Error message type
        code:
          type: string
          description: Error message code
        parameters:
          description: Error message parameters
          $ref: '#/components/schemas/Parameters'
      additionalProperties: false
      required:
      - message
    SharingSettingDeleteResponse:
      description: A JSON schema for the Sharing settings object response for delete request
      type: object
      properties:
        pcId:
          type: string
          format: uuid
      additionalProperties: false
      required:
      - pcId
    SharingSettingResponse:
      description: A JSON schema for the Sharing settings object response for post request
      type: object
      properties:
        createSettingsPCId:
          type: string
          format: uuid
        updateSettingsPCId:
          type: string
          format: uuid
      additionalProperties: false
      required:
      - createSettingsPCId
      - updateSettingsPCId
    Errors:
      description: A set of errors
      type: object
      properties:
        errors:
          description: List of errors
          type: array
          items:
            type: object
            $ref: '#/components/schemas/Error'
        total_records:
          description: Total number of errors
          type: integer
      additionalProperties: false
    Parameter:
      description: List of key/value parameters of an error
      type: object
      properties:
        key:
          type: string
          minLength: 1
        value:
          type: string
      additionalProperties: false
      required:
      - key
    Parameters:
      description: List of key/value parameters of an error
      type: array
      items:
        $ref: '#/components/schemas/Parameter'
      additionalProperties: false
    uuid:
      type: string
      format: uuid
    ValidationError:
      type: object
      required:
      - message
      - path
      - _links
      properties:
        message:
          type: string
        path:
          type: string
        _links:
          type: object
          required:
          - self
          properties:
            self:
              type: object
              required:
              - href
              properties:
                href:
                  type: string
                  format: uri
    ValidationErrorResponse:
      description: 'Validation error body returned when a create/update request fails domain-object validation. Shape depends on the number of errors: a single ValidationError when there is exactly one, otherwise a wrapper with a count and an embedded array.'
      oneOf:
      - $ref: '#/components/schemas/ValidationError'
      - type: object
        required:
        - total
        - _embedded
        properties:
          total:
            type: integer
          _embedded:
            type: object
            properties:
              errors:
                type: array
                items:
                  $ref: '#/components/schemas/ValidationError'
    SpringBootErrorResponse:
      type: object
      description: Spring Boot's default error body. Emitted by the servlet container itself when a request ends in an error status with no response body written by the application, rather than by this app's own error handling - so it does not match the `HttpError` shape used elsewhere in this API.
      properties:
        timestamp:
          type: integer
          description: Epoch milliseconds
        status:
          type: integer
        error:
          type: string
        path:
          type: string
    resultInfo:
      description: Common result set information for streaming response
      type: object
      properties:
        totalRecords:
          description: Total number of entries in response
          type: integer
        diagnostics:
          description: Diagnostics for response
          type: array
          items:
            type: object
            properties:
              message:
                description: single diagnostic message
                type: string
        facets:
          type: array
          description: Array of facets
          items:
            type: object
            description: A facet
            properties:
              facetValues:
                type: array
                description: Array of facet values
                items:
                  type: object
                  description: A facet value
                  properties:
                    count:
                      type: integer
                      description: Count of facet values
                    value:
                      description: Value Object
              type:
                type: string
                description: Type of facet
      additionalProperties: false
    entry:
      description: Setting
      type: object
      properties:
        id:
          description: Identifier
          type: string
          format: uuid
        scope:
          type: string
          description: Scope for this entry (normally a module)
        key:
          type: string
          description: Key within scope for this setting
        value:
          description: Settings value (any type)
        userId:
          type: string
          format: uuid
          description: Owner of this setting (optional)
      additionalProperties: false
      required:
      - id
      - scope
      - key
      - value
    uploadResponse:
      description: Upload response
      type: object
      properties:
        inserted:
          type: integer
          description: Number of settings inserted
        updated:
          type: integer
          description: Number of settings updated
      additionalProperties: true
      required:
      - inserted
      - updated
    uploadRequest:
      description: Settings upload request body
      type: array
      items:
        type: object
        properties:
          scope:
            type: string
            description: Scope for this entry (normally a module)
          key:
            type: string
            description: Key within scope for this setting
          value:
            description: Settings value (any type)
          userId:
            type: string
            format: uuid
            description: Owner of this setting (optional)
        additionalProperties: false
        required:
        - scope
        - key
        - value
    entries:
      description: Setting entries response
      type: object
      properties:
        items:
          description: List of settings
          type: array
          items:
            type: object
            $ref: '#/components/schemas/entry'
        resultInfo:
          description: Common result set information
          type: object
          $ref: '#/components/schemas/resultInfo'
      additionalProperties: false
      required:
      - items
  responses:
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    SharingSettingResponse:
      description: Returns a sharing setting object response for post operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SharingSettingResponse'
          example:
            createSettingsPCId: c734a41e-16ba-4a02-beb0-2d45081e39b1
            updateSettingsPCId: 53e0f091-ffee-448c-a0f8-562d9ad6bf3f
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    Conflict:
      description: Validation errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    SharingSettingDeleteResponse:
      description: Returns a sharing setting response for delete operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SharingSettingDeleteResponse'
          example:
            pcId: c734a41e-16ba-4a02-beb0-2d45081e39b1
    trait_413:
      description: Payload Too Large
      content:
        text/plain:
          schema:
            type: string
    trait_404:
      description: Not Found
      content:
        text/plain:
          schema:
            type: string
            example: Identifier 596d9f60-cda3-44d2-a4a1-2f48b7d4d23c not found
        application/json:
          schema:
            type: object
            example:
              error: Identifier 596d9f60-cda3-44d2-a4a1-2f48b7d4d23c not found
    trait_500:
      description: Internal error
      content:
        text/plain:
          schema:
            type: string
            example: Internal server error, contact administrator
    trait_403:
      description: Forbidden
      content:
        text/plain:
          schema:
            type: string
            example: Insufficient permissions to access resource
        application/json:
          schema:
            type: object
            example:
              error: Insufficient permissions to access resource
    trait_400:
      description: Bad request
      content:
        text/plain:
          schema:
            type: string
            example: Invalid JSON in request
        application/json:
          schema:
            type: object
            example:
              error: Invalid JSON in request
    SharingSettingResponse_2:
      description: Returns a sharing setting object response for post operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SharingSettingResponse'
    SharingSettingDeleteResponse_2:
      description: Returns a sharing setting response for delete operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SharingSettingDeleteResponse'
  requestBodies:
    SharingSettingBody:
      description: Sharing settings object
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SharingSettingRequest'
          example:
            settingId: 1844767a-8367-4926-9999-514c35840399
            url: /organizations-storage/organizations
            payload:
              id: 1844767a-8367-4926-9999-514c35840399
              name: ORG-NAME
              source: local
    SharingSettingBody_2:
      description: Sharing settings object
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SharingSettingRequest'
  securitySchemes:
    okapiToken:
      type: apiKey
      in: header
      name: x-okapi-token
    accessToken:
      type: apiKey
      in: cookie
      name: folioAccessToken
x-refined-from:
- folio-mod-agreements-openapi.json
- folio-mod-consortia-keycloak-sharing-settings-openapi.json
- folio-mod-licenses-openapi.json
- folio-mod-oa-openapi.json
- folio-mod-settings-openapi.json
- folio-mod-agreements-openapi.yml
- folio-mod-consortia-keycloak-sharing-settings-openapi.yml
- folio-mod-consortia-sharing-settings-openapi.yml
- folio-mod-licenses-openapi.yml
- folio-mod-oa-openapi.yml
- folio-mod-settings-openapi.yml