Page Comparison

openapi: 3.0.3
info:
  title: Patron creation
  description: Edge API for creation of patron account through web-form
  version: 1.0.0
servers:
  - url: 'https://github.com/folio-org/mod-patron'
paths:
  /patron/account/{email}:
    get:
      description: Get patron account by email
      tags:
        - patron
      parameters:
        - in: path
          name: email
          schema:
            type: string
          required: true
      responses:
        201:
          $ref: "#/components/requestBodies/PatronAccountRequest"
        404:
          $ref: '#/components/responses/NotFound'
    put:
      description: Update Patron Account by email
      operationId: updatePatronByEmail
      tags:
        - patron
      parameters:
        - in: path
          name: email
          schema:
            type: string
          required: true
      requestBody:
        $ref: "#/components/requestBodies/PatronAccountRequest"
      responses:
        201:
          $ref: "#/components/requestBodies/PatronAccountRequest"
        404:
          $ref: '#/components/responses/NotFound'
        400:
      description: Create Patron Account    $ref: '#/components/responses/BadRequest'
        500:
 operationId:  createPatron       tags$ref: '#/components/responses/InternalServerError'
  /patron/account:
    -get:
patron       requestBodydescription: Get Expired records
     $ref operationId: "#/components/requestBodies/PatronAccountRequest"getExpiredRecords
      responsestags:
        201:- patron
         $ref: "#/components/requestBodies/PatronAccountRequest"parameters:
        404- in: query
         $ref name: '#/components/responses/NotFound' expired
          400description: flag to fetch expired records
        $ref  required: '#/components/responses/BadRequest'true
      responses:
  500:      201:
      $ref: '#/components/responses/InternalServerError'   componentsdescription: A  schemas:
JSON array of user names
   PatronAccount:       typecontent:
 object           descriptionapplication/json:
Information for patron registration for web-form       required:  schema:
      - generalInfo         -type: address0array
        - contactInfo       items:
 - preferences         - userType       properties:$ref: "#/components/schemas/ExpiredPatronAccount"
        generalInfo404:
          description$ref: General info'#/components/responses/NotFound'
        400:
  type: object       $ref: '#/components/responses/BadRequest'
  required:      500:
      - firstName   $ref: '#/components/responses/InternalServerError'
    post:
    - lastName description: Create Patron Account
      propertiesoperationId: createPatron
         tags:
 title:       - patron
      descriptionrequestBody:
Title        $ref: "#/components/requestBodies/PatronAccountRequest"
      typeresponses:
string        201:
    firstName:      $ref: "#/components/requestBodies/PatronAccountRequest"
       description 404:
First Name         $ref: '#/components/responses/NotFound'
     type: string  400:
          middleName$ref:  '#/components/responses/BadRequest'
        500:
   description: Middle Name     $ref: '#/components/responses/InternalServerError'


components:
     typeschemas:
string    ExpiredPatronAccount:
        lastNametype: object
      description: Information on expired patron accoun
 description: Last Name   properties:
           typeexternalSystemId:
string          address0description: External System  ID
      description: Current address/Address 0 type: string
        typefirstName:
object           propertiesdescription: First Name
          addressLine0type: string
        preferredFirstName:
     description: Current Address/Address line 0 description: Preferred First Name
          type: string
        middleName:
    addressLine1:      description: Middle Name
      description: Current Address/Address line 1type: string
        lastName:
    type: string     description: Last Name
     city:     type: string
        descriptionemail:
City          description: Email Address
  type: string       type: string
    province:    expirationDate:
          description: State/ProvinceExpiration Date
             type: string
          format: date
zip:    PatronAccount:
      type: object
  description: Zip/Postal Code  description: Information for patron registration for web-form
      typerequired:
string        - generalInfo
   country:     - address
        description:- CountrycontactInfo
        - userType
    type: string properties:
        address1generalInfo:
          description: Address on Photo ID/Address 1 (optional)General info
          type: object
          propertiesrequired:
            addressLine0:- firstName
            - description:lastName
Current Address/Address line 0               type: stringproperties:
            addressLine1externalSystemId:
              description: CurrentExternal Address/Address line 1System ID
              type: string
            cityfirstName:
              description: First CityName
              type: string
            provincepreferredFirstName:
              description: State/ProvincePreferred First Name
              type: string
            zipmiddleName:
              description: Zip/PostalMiddle CodeName
              type: string
            countrylastName:
              description: CountryLast Name
              type: string

        contactInfoaddress:
          description: ContactCurrent infoaddress/Address
          type: object
          requiredproperties:
            -addressLine0:
   homePhone           description:  - emailCurrent Address/Address line 0
              propertiestype: string
            homePhoneaddressLine1:
              description: Home Phone Current Address/Address line 1
              type: string
            mobilePhonecity:
              description: MobileCity
Phone               type: string
            localPhoneprovince:
              description: Local PhoneState/Province
              type: string
            emailzip:
              description: EmailZip/Postal AddressCode
              type: string
         preferences:   country:
       type: object      description: Country
   description: Preferences           propertiestype: string

        contactInfo:
 serviceEmailAlertsEnabled:         description: Contact info
   description: I would like to receive email communications fromtype: theobject
Library of Congress about service requests and alerts, research information, andrequired:
surveys related to doing research at the Library.     - phone
        type: boolean   - email
          defaultproperties:
false             programEmailAlertsEnabledphone:
              description: IPhone wouldNumber
like to receive email communications from the Library of Congress about other Library programs (concerts, exhibits, lectures, etc.), customer surveys, and other services available to the general public.type: string
            mobilePhone:
              typedescription: booleanMobile Phone
              defaulttype: falsestring
            supportEmailAlertsEnabledemail:
              description: Email IAddress
would like to receive email communications from the Library of Congress about how I mighttype: supportstring
the
Library.        preferences:
      type: boolean   type: object
          defaultdescription: Preferences
false          userTypeproperties:
          description: User TypeserviceEmailAlertsEnabled:
          type: object   description: I would like to receive email communications required:from the Library of Congress about service requests and alerts, research information, and -surveys agerelated to doing research at the Library.
      - use       type:  boolean
 properties:             agedefault: false
             descriptionprogramEmailAlertsEnabled: Age
              typedescription: integer I would like to receive email communications from the Library of Congress use:about other Library programs (concerts, exhibits, lectures, etc.), customer surveys, and other services available to default:the Use (Academic/personal)general public.
              type: stringboolean
              enumdefault: [ "ACADEMIC", "PERSONAL" ]false
            academicStatussupportEmailAlertsEnabled:
              description: Academic Status (required if "use" is ACADEMIC)
   I would like to receive email communications from the Library of Congress about how I might support the Library.
         institution:     type: boolean
        description: Academic Institution (required if "use" isdefault: ACADEMIC)false

    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"
      additionalProperties: false
      required:
        - message

  requestBodies:
    PatronAccountRequest:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PatronAccount"

  responses:
    PatronAccountResponse:
      description: SuccessfulResult
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PatronAccount"

    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"