spec_swagger.yaml

swagger: '2.0'
info:
  version: 1.0.0
  title: CultureMesh
host: www.culturemesh.com
basePath: /api/v1
tags:
  - name: users
    description: Data and actions about CultureMesh users.
  - name: networks
    description: Data and actions about CultureMesh networks.
  - name: posts
    description: Data and actions about CultureMesh posts.
  - name: events
    description: Data and actions about CultureMesh events.
  - name: locations
    description: API for getting location information from CultureMesh.
  - name: languages
    description: API for getting language information from CultureMesh.
  - name: accounts
    description: Data and actions about CultureMesh accounts.

securityDefinitions:
  basicAuth:
    type: basic
schemes:
  - https
paths:
  '/user/{userId}':
    get:
      tags:
        - users
      summary: Get a particular user.
      description: Gets a user.
      operationId: getUser
      produces:
        - application/json
      parameters:
        - name: userId
          in: path
          description: ID of user to return.
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/User'
        '405':
          description: Invalid input

  '/user/{userId}/networks':
    get:
      tags:
        - users
      summary: Get networks a user belongs to.
      description: ''
      operationId: getUserNetworks
      produces:
        - application/json
      parameters:
        - name: userId
          in: path
          description: ID of user to return.
          required: true
          type: integer
          format: int64
        - in: query
          name: count
          type: integer
          description: |
            The number of results to return.  Between 1 and 100.
        - in: query
          name: max_registration_date
          type: string
          format: timestamp
          description: |
            The latest registration date, inclusive, in the networks returned.
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/NetworkWithJoin'
        '405':
          description: Invalid input
  '/user/{userId}/posts':
    get:
      tags:
        - users
      summary: Get list of posts made by a user.
      description: ''
      operationId: getUserPosts
      produces:
        - application/json
      parameters:
        - name: userId
          in: path
          description: ID of user to return.
          required: true
          type: integer
          format: int64
        - in: query
          name: count
          type: integer
          description: |
            The number of results to return.  Between 1 and 100.
        - in: query
          name: max_id
          type: integer
          description: |
            The maximum ID, inclusive, to return data for.
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Post'
        '405':
          description: Invalid input
  '/user/{userId}/events':
    get:
      tags:
        - users
      summary: Get list of events associated with a user.
      description: ''
      operationId: getUserEvents
      produces:
        - application/json
      parameters:
        - name: userId
          in: path
          description: ID of user to return.
          required: true
          type: integer
          format: int64
        - in: query
          name: role
          description: 'Can be "hosting" or " attending"  '
          required: true
          type: string
          enum:
            - hosting
            - attending
        - in: query
          name: count
          type: integer
          description: |
            The number of results to return.  Between 1 and 100.
        - in: query
          name: max_id
          type: integer
          description: |
            The maximum ID, inclusive, to return data for.
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Event'
        '405':
          description: Invalid input
  '/event/currentUserEventsByNetwork/{networkId}':
    get:
      security:
          - basicAuth: []
      tags:
        - users
        - events
      summary: Get events that a user is a attending in a network.
      description: ''
      produces:
        - application/json
      parameters:
        - name: networkId
          in: path
          description: ID of network.
          required: true
          type: integer
        - in: query
          name: count
          type: integer
          description: |
            The number of results to return.  Between 1 and 100.
        - in: query
          name: max_id
          type: integer
          description: |
            The maximum ID, inclusive, to return data for.
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
                $ref: "#/definitions/Event"
  '/user/joinEvent/{eventId}':
    post:
      security:
            - basicAuth: []
      tags:
        - users
      summary: Add user to an event.
      description: ''
      operationId: addUserToEvent
      produces:
        - application/json
      parameters:
        - name: eventId
          in: path
          description: ID of event to add user to.
          required: true
          type: integer
        - name: role
          in: query
          description: role of user. Either 'host' or 'guest'
          required: true
          type: string
      responses:
        '200':
          description: OK
        '405':
          description: Invalid input
  '/user/leaveEvent/{eventId}':
    delete:
      security:
            - basicAuth: []
      tags:
        - users
      summary: Removes a user from an event.
      description: ''
      produces:
        - application/json
      parameters:
        - name: eventId
          in: path
          description: ID of event to add user to.
          required: true
          type: integer
      responses:
        '200':
          description: OK
        '405':
          description: Invalid input
  '/user/joinNetwork/{networkId}':
    post:
      security:
        - basicAuth: []
      tags:
        - users
      summary: Adds user to a network.
      description: ''
      operationId: addUserToNetwork
      produces:
        - application/json
      parameters:
        - name: networkId
          in: path
          description: ID of network to add user to.
          required: true
          type: integer
      responses:
        '200':
          description: OK
        '405':
          description: Invalid input
        '401':
          $ref: "#/responses/UnauthorizedError"
  '/user/leaveNetwork/{networkId}':
    delete:
      security:
        - basicAuth: []
      tags:
        - users
      summary: let user leave network.
      description: notice that no error will be thrown if user never joined the network in the first place.
      parameters:
        - in: path
          name: networkId
          required: true
          type: integer
          description: Id of network you want to leave.
      responses:
        '200':
          description: User 155 left network 544
        '401':
          $ref: "#/responses/UnauthorizedError"
  /user/users:
    get:
      tags:
        - users
      summary: Get users.
      description: ''
      operationId: getUsers
      produces:
        - application/json
      parameters:
        - in: query
          name: count
          type: integer
          description: |
            The number of results to return.  Between 1 and 100.
        - in: query
          name: max_id
          type: integer
          description: |
            The maximum ID, inclusive, to return data for.
        - in: query
          name: near_location
          type: string
          description: |
            A comma-separated list of country_id, region_id, and city_id, in that order.
        - in: query
          name: from_location
          type: string
          description: |
             A comma-separated list of country_id, region_id, and city_id, in that order.
        - in: query
          name: language
          type: string
          description: |
             Name of language.
      responses:
        '200':
          description: A list of users matching filter.
          schema:
            type: array
            items:
              $ref: '#/definitions/User'
        '405':
          description: Invalid input
    post:
      tags:
        - users
      summary: Create a new user
      description: ''
      operationId: createUser
      consumes:
        - application/json
      parameters:
        - in: body
          name: user
          description: Created user object
          required: true
          schema:
            $ref: '#/definitions/NewUser'
      responses:
        '200':
          description: OK
  '/user/update_user':
    put:
      security:
        - basicAuth: []
      tags:
        - users
      summary: Update a user
      description: Uses the ID given in the JSON object to determine
                   what user tuple to modify, then updates the rest
                   of the fields with the JSON values given. Note
                   that it is impossible to update a user id.
      operationId: updateUser
      consumes:
        - application/json
      parameters:
        - in: body
          name: body
          description: User object with which to update
          required: true
          schema:
            $ref: '#/definitions/User'
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: "#/definitions/Network"
  /network/popular:
    get:
      tags:
        - networks
      summary: Get the n most popular networks.
      description: 'Get the n networks with the highest number of subscribed users. Used for naive network recommendations.'
      parameters:
        - in: query
          name: count
          description: The number of networks to return.
          required: true
          type: integer
      produces:
        - applicaton/json
      responses:
        '200':
          description: OK
  /network/networks:
    get:
      tags:
        - networks
      summary: Get a list of all networks.
      description: 'Notice: if you are querying for an null parameter, pass -1 instead. '
      operationId: getNetworks
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: query
          name: count
          type: integer
          description: |
            The number of results to return.  Between 1 and 100.
        - in: query
          name: max_id
          type: integer
          description: |
            The maximum ID, inclusive, to return data for.
        - in: query
          name: near_location
          type: string
          description: |
            A comma-separated list of country_id, region_id, and city_id, in that order.
        - in: query
          name: from_location
          type: string
          description: |
             A comma-separated list of country_id, region_id, and city_id, in that order.
        - in: query
          name: language
          type: string
          description: |
             Name of language.
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Network'
        '405':
          description: Invalid input
  '/network/{networkId}':
    get:
      tags:
        - networks
      summary: Get a specific network.
      description: ''
      operationId: getNetwork
      produces:
        - application/json
      parameters:
        - name: networkId
          in: path
          description: ID of network to return.
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Network'
        '405':
          description: Invalid input
  '/network/{networkId}/posts':
    get:
      tags:
        - networks
      summary: Get all posts in a network.
      description: ''
      operationId: getNetworkPosts
      produces:
        - application/json
      parameters:
        - name: networkId
          in: path
          description: ID of network to get posts from.
          required: true
          type: integer
          format: int64
        - in: query
          name: count
          type: integer
          description: |
            The number of results to return.  Between 1 and 100.
        - in: query
          name: max_id
          type: integer
          description: |
            The maximum ID, inclusive, to return data for.
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Post'
        '405':
          description: Invalid input

  '/network/{networkId}/post_count':
    get:
      tags:
        - networks
      summary: Get the number of posts in a network.
      description: ''
      operationId: getNetworkPostCount
      produces:
        - application/json
      parameters:
        - name: networkId
          in: path
          description: ID of network to count posts for.
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          schema:
            type: object
            properties:
              post_count:
                type: integer
                format: int64
                example: 120
        '405':
          description: Invalid input

  '/network/{networkId}/events':
    get:
      tags:
        - networks
      summary: Get all events in a network.
      description: ''
      operationId: getNetworkEvents
      produces:
        - application/json
      parameters:
        - name: networkId
          in: path
          description: ID of network get events from.
          required: true
          type: integer
          format: int64
        - in: query
          name: count
          type: integer
          description: |
            The number of results to return.  Between 1 and 100.
        - in: query
          name: max_id
          type: integer
          description: |
            The maximum ID, inclusive, to return data for.
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Event'
        '405':
          description: Invalid input

  '/network/{networkId}/users':
    get:
      tags:
        - networks
      summary: Get all members of a network.
      description: ''
      operationId: getNetworkUsers
      produces:
        - application/json
      parameters:
        - name: networkId
          in: path
          description: ID of network to return members from.
          required: true
          type: integer
          format: int64
        - in: query
          name: count
          type: integer
          description: |
            The number of results to return.  Between 1 and 100.
        - in: query
          name: max_register_date
          type: string
          format: timestamp
          description: |
            The latest user registration date, inclusive, to users for.
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/NetworkRegistration'
        '405':
          description: Invalid input

  '/network/{networkId}/user_count':
    get:
      tags:
        - networks
      summary: Get the number of users that belong in a network.
      description: ''
      operationId: getNetworkUserCount
      produces:
        - application/json
      parameters:
        - name: networkId
          in: path
          description: ID of network to count users for.
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          schema:
            type: object
            properties:
              user_count:
                type: integer
                format: int64
                example: 250
        '405':
          description: Invalid input

  '/post/{postId}':
    get:
      tags:
        - posts
      summary: Get a post.
      description: ''
      operationId: getPost
      produces:
        - application/json
      parameters:
        - name: postId
          in: path
          description: ID of post to return.
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: The post object
          schema:
            $ref: '#/definitions/Post'
        '405':
          description: Invalid input

  '/post/reply/{replyId}':
    get:
      tags:
        - posts
      summary: Get a post reply.
      description: ''
      operationId: getPostReply
      produces:
        - application/json
      parameters:
        - name: replyId
          in: path
          description: ID of post reply to return.
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: The post reply object
          schema:
            $ref: '#/definitions/PostReply'
        '405':
          description: Invalid input

  '/post/{postId}/replies':
    get:
      tags:
        - posts
      summary: Get the replies for a post.
      operationId: getPostReplies
      produces:
        - application/json
      parameters:
        - name: postId
          in: path
          description: ID of post to get replies for.
          required: true
          type: integer
          format: int64
        - in: query
          name: count
          type: integer
          description: |
            The number of results to return.  Between 1 and 100.
        - in: query
          name: max_id
          type: integer
          description: |
            The maximum ID, inclusive, to return data for.
      responses:
        '200':
          description: The post object
          schema:
            type: array
            items:
              $ref: '#/definitions/PostReply'
        '404':
          description: Post does not exist.
        '405':
          description: Invalid input

  '/post/{postId}/reply_count':
    get:
      tags:
        - posts
      summary: Get the number of replies for a post
      operationId: getPostReplyCount
      produces:
        - application/json
      parameters:
        - name: postId
          in: path
          description: ID of post to get reply count for
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          schema:
            type: object
            properties:
              reply_count:
                type: integer
                format: int64
                example: 12

  /post/new:
    post:
      security:
            - basicAuth: []
      tags:
        - posts
      summary: Create a post.
      description: ''
      operationId: createPost
      consumes:
        - application/json
      parameters:
        - in: body
          name: post
          description: The post specification.
          required: true
          schema:
            $ref: '#/definitions/NewPost'
      responses:
        '200':
          description: Ok
        '405':
          description: Invalid input
    put:
      security:
          - basicAuth: []
      tags:
        - posts
      summary: Update a post.
      description: ''
      operationId: updatePost
      consumes:
        - application/json
      parameters:
        - in: body
          name: post
          description: The post specification.
          required: true
          schema:
            $ref: '#/definitions/NewPost'
      responses:
        '200':
          description: Ok
        '405':
          description: Invalid input


  '/post/{postId}/reply':
    post:
      security:
          - basicAuth: []
      tags:
        - posts
      summary: Reply to a post.
      description: ''
      operationId: replyToPost
      consumes:
        - application/json
      parameters:
        - name: postId
          in: path
          description: ID of post to reply to.
          required: true
          type: integer
          format: int64
        - in: body
          name: post_reply
          description: The post specification.
          required: true
          schema:
            $ref: '#/definitions/NewPostReply'
      responses:
        '200':
          description: Ok
        '405':
          description: Invalid input
    put:
      tags:
        - posts
      summary: Update a post reply.
      description: ''
      operationId: updatePostReply
      consumes:
        - application/json
      parameters:
        - name: postId
          in: path
          description: ID of post to update
          required: true
          type: integer
          format: int64
        - in: body
          name: post
          description: The post specification.
          required: true
          schema:
            $ref: '#/definitions/NewPostReply'
      responses:
        '200':
          description: Ok
        '405':
          description: Invalid input


  '/event/{eventId}':
    get:
      tags:
        - events
      summary: Get an event.
      description: ''
      operationId: getEvent
      produces:
        - application/json
      parameters:
        - name: eventId
          in: path
          description: ID of event to return.
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/Event'
        '405':
          description: Invalid input

  '/event/{eventId}/reg':
    get:
      tags:
        - events
      summary: Get list of registration JSONs for an event.
      description: ''
      operationId: getEventAttendance
      produces:
        - application/json
      parameters:
        - name: eventId
          in: path
          description: ID of event to fetch attendees.
          required: true
          type: integer
          format: int64
        - in: query
          name: count
          type: integer
          description: |
            The number of results to return.  Between 1 and 100.
        - in: query
          name: max_register_date
          type: string
          format: timestamp
          description: |
            The latest date of registration, inclusive, to return data for.
      responses:
        '200':
          description: Ok
          schema:
            type: array
            items:
              $ref: '#/definitions/EventRegistration'
        '405':
          description: Invalid input

  '/event/{event_id}/reg_count':
    get:
      tags:
        - events
      summary: Get the number of people registered for this event.
      description: ''
      operationId: getEventAttendanceCount
      produces:
        - application/json
      parameters:
        - name: event_id
          in: path
          description: ID of event to fetch registration count.
          required: true
          type: integer
          format: int64.
      responses:
        '200':
          description: Ok
          schema:
            type: integer

  '/event/delete':
    delete:
      security:
            - basicAuth: []
      tags:
        - events
      summary: Deletes an event.
      description: >
        Unregisters everyone from an event and then deletes it.
        If the event never existed, does not return an error.
      operationId: deleteEvent
      parameters:
        - in: query
          name: id
          type: integer
          required: true
          description: The id of the event to delete.
      responses:
        '200':
          description: Ok
        '400':
          description: Bad request.

  /event/new:
    post:
      security:
            - basicAuth: []
      tags:
        - events
      summary: Create an event.
      description: ''
      operationId: newEvent
      consumes:
        - application/json
      parameters:
        - in: body
          name: event
          description: The event specification.
          required: true
          schema:
            $ref: '#/definitions/NewEvent'
      responses:
        '200':
          description: Ok
        '405':
          description: Invalid input
    put:
      security:
          - basicAuth: []
      tags:
        - events
      summary: Update an event.
      description: ''
      operationId: updateEvent
      consumes:
        - application/json
      parameters:
        - in: body
          name: event
          description: The event specification.
          required: true
          schema:
            $ref: '#/definitions/Event'
      responses:
        '200':
          description: Ok
        '405':
          description: Invalid input

  '/location/cities/{cityId}':
    get:
      tags:
        - locations
      summary: Get information about a city.
      operationId: getCity
      produces:
        - application/json
      parameters:
        - name: cityId
          in: path
          description: ID of city to get info from.
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/City'
        '405':
          description: Invalid input
  '/location/regions/{regionId}':
    get:
      tags:
        - locations
      summary: Get information about a region.
      description: ''
      operationId: getRegion
      produces:
        - application/json
      parameters:
        - name: regionId
          in: path
          description: ID of region to get info from.
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/Region'
        '405':
          description: Invalid input
  '/location/countries/{countryId}':
    get:
      tags:
        - locations
      summary: Get information about a country.
      description: ''
      operationId: getCountry
      produces:
        - application/json
      parameters:
        - name: countryId
          in: path
          description: ID of country to get info from.
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/Country'
        '405':
          description: Invalid input
  /location/autocomplete:
    get:
      tags:
        - locations
      summary: Get an array of autocomplete entries for a location.
      description: ''
      operationId: getLocationAutocomplete
      produces:
        - application/json
      parameters:
        - name: input_text
          in: query
          description: Partial input query text.
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: Ok
          schema:
            type: array
            items:
              $ref: '#/definitions/Location'
        '405':
          description: Invalid input
  '/language/{langId}':
    get:
      tags:
        - languages
      summary: Get language information by id.
      description: ''
      operationId: getLangById
      produces:
        - application/json
      parameters:
        - name: langId
          in: path
          description: ID of language to get information for.
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/Language'
        '405':
          description: Invalid input
  /language/autocomplete:
    get:
      tags:
        - languages
      summary: Get an array of autocomplete entries for a language.
      description: ''
      operationId: getLanguageAutocomplete
      produces:
        - application/json
      parameters:
        - name: input_text
          in: query
          description: Partial input query text.
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: Ok
          schema:
            type: array
            items:
              $ref: '#/definitions/Language'
        '405':
          description: Invalid input
  '/upload/image':
    post:
      security:
          - basicAuth: []
      consumes:
        - "multipart/form-data"
      tags:
        - uploads
      summary: Upload an image to the BlueHost server.
      produces:
        - text/plain
      parameters:
        - name: file
          in: formData

          description: Image file < 2MB and of type .png, .gif, or  .jpg
          required: true
          type: file
          format: int64
      description: |
        Uploads image to server. Must pass file in enctype multipart-formdata with key being 'file' and value being the file itself. Acceptable file types are .png, .jpg, and .gif. The file must also be < 2MB.
      responses:
        '200':

          description: Returns new URL for image.
        '405':
          description: Invalid file type.
        '413':
          description: File too large (>= 2MB)
  '/account/token':
    get:
      security:
        - basicAuth: []
      tags:
        - accounts
      summary: Get user token.
      description: Gets user token that can be passed in place of email/password combo for @auth.login_required() routes. Lasts for 600 seconds. To pass user/password credentials, try running "curl -u <email>:<password> <rest_of_command>". The email and password combo is encoded in Base64 in the header under key "Authorization".
      operationId: verify_account
      produces:
        - application/json
      parameters:
        - name: email
          in: header
          description: Email or token for login.
          required: true
          type: string
        - name: password
          in: header
          description: Password for login.
          required: true
          type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/TokenObject'
        '401':
          description: Unauthorized

responses:
  UnauthorizedError:
    description: Authentication information is missing or invalid

definitions:
  NetworkFilter:
    type: object
    properties:
      locations_cur:
        type: array
        items:
          $ref: '#/definitions/Location'
      locations_origin:
        type: array
        items:
          $ref: '#/definitions/Location'
      languages_origin:
        type: array
        items:
          type: string

  UserFilter:
    type: object
    properties:
      near_location:
        type: array
        items:
          $ref: '#/definitions/Location'
      from_location:
        type: array
        items:
          $ref: '#/definitions/Location'
      languages:
        type: array
        items:
          type: string

  TokenObject:
    type: object
    properties:
      id:
        type: integer
        format: int64
      username:
        type: string
      first_name:
        type: string
      last_name:
        type: string
      email:
        type: string
      role:
        type: integer
        format: int32
      gender:
        type: string
      about_me:
        type: string
      confirmed:
        type: boolean
      img_link:
        type: string
        description: URL of image
      token:
        type:  string

  User:
    type: object
    required:
      - id
      - first_name
      - last_name
      - email
      - username
      - role
      - act_code
    properties:
      id:
        type: integer
        format: int64
      username:
        type: string
      first_name:
        type: string
      last_name:
        type: string
      email:
        type: string
      register_date:
        type: string
        format: timestamp
      role:
        type: integer
        format: int32
      last_login:
        type: string
        format: timestamp
      gender:
        type: string
      about_me:
        type: string
      confirmed:
        type: boolean
      act_code:
        type: string
        description: Not sure what this is.
      img_link:
        type: string
        description: URL of image
      fp_code:
        type: string
        description: Not sure what this is.

  NewUser:
    description: The fields needed to create a new user.
    type: object
    properties:
      username:
        type: string
      password:
        type: string
      first_name:
        type: string
      last_name:
        type: string
      email:
        type: string
      role:
        type: integer
        format: int32
      img_link:
        type: string
      about_me:
        type: string
      gender:
        type: string

  Network:
    type: object
    required:
      - id
      - location_cur
    properties:
      id:
        type: integer
        format: bigint20
      city_cur:
        type: string
      id_city_cur:
        type: integer
        format: bigint20
      region_cur:
        type: string
      id_region_cur:
        type: integer
        format: bigint2
      country_cur:
        type: string
      id_country_cur:
        type: integer
        format: bigint20
      city_origin:
        type: string
      id_city_origin:
        type: integer
        format: bigint20
      region_origin:
        type: string
      id_region_origin:
        type: integer
        format: bigint20
      country_origin:
        type: string
      id_country_origin:
        type: integer
        format: bigint20
      language_origin:
        type: string
      id_language_origin:
        type: integer
        format: bigint20
      network_class:
        type: string
        description: |
         _l - language
          cc - city
          rc - region
          co - country
      date_added:
        type: string
        format: timestamp
      img_link:
        type: string
      twitter_query_level:
        type: string

  NewNetwork:
    description: The fields needed to create a new network.
    type: object
    required:
      - id
      - location_cur
    properties:
      id_city_cur:
        type: integer
        format: bigint20
      city_cur:
        type: string
      id_region_cur:
        type: integer
        format: bigint20
      region_cur:
        type: string
      id_country_cur:
        type: integer
        format: bigint20
      country_cur:
        type: string
      id_city_origin:
        type: integer
        format: bigint20
      city_origin:
        type: string
      id_region_origin:
        type: integer
        format: bigint20
      region_origin:
        type: string
      id_country_origin:
        type: integer
        format: bigint20
      country_origin:
        type: string
      id_language_origin:
        type: integer
        format: bigint20
      language_origin:
        type: string
      network_class:
        type: string

  NetworkWithJoin:
    description: |
      A Network with the join_date of the user for which this network
      was invoked for, e.g., the /user/{userId}/networks call.
    type: object
    required:
      - id
      - location_cur
    properties:
      id:
        type: integer
        format: bigint20
      city_cur:
        type: string
      id_city_cur:
        type: integer
        format: bigint20
      region_cur:
        type: string
      id_region_cur:
        type: integer
        format: bigint2
      country_cur:
        type: string
      id_country_cur:
        type: integer
        format: bigint20
      city_origin:
        type: string
      id_city_origin:
        type: integer
        format: bigint20
      region_origin:
        type: string
      id_region_origin:
        type: integer
        format: bigint20
      country_origin:
        type: string
      id_country_origin:
        type: integer
        format: bigint20
      language_origin:
        type: string
      id_language_origin:
        type: integer
        format: bigint20
      network_class:
        type: string
        description: |
         _l - language
          cc - city
          rc - region
          co - country
      date_added:
        type: string
        format: timestamp
      img_link:
        type: string
      twitter_query_level:
        type: string
      join_date:
        format: timestamp

  NetworkRegistration:
    type: object
    required:
      - id_user
      - id_network
    properties:
      id_user:
        type: integer
        format: int64
      id_network:
        type: integer
        format: int64
      join_date:
        type: string
        format: timestamp

  NewEvent:
    description: The fields needed to create a new event.
    type: object
    required:
      - id
    properties:
      id_network:
        type: integer
        format: int64
      id_host:
        type: integer
        format: int64
      event_date:
        type: string
        format: date-time
      title:
        type: string
      address_1:
        type: string
      address_2:
        type: string
      country:
        type: string
      city:
        type: string
      region:
        type: string
      description:
        type: string

  Event:
    type: object
    required:
      - id
    properties:
      id:
        type: integer
        format: int64
      id_network:
        type: integer
        format: int64
      id_host:
        type: integer
        format: int64
      date_created:
        type: string
        format: timestamp
      event_date:
        type: string
        format: date-time
      title:
        type: string
      address_1:
        type: string
      address_2:
        type: string
      country:
        type: string
      city:
        type: string
      region:
        type: string
      description:
        type: string

  EventRegistration:
    type: object
    required:
      - id_guest
      - id_event
    properties:
      id_guest:
        type: integer
        format: int64
      id_event:
        type: integer
        format: int64
      date_registered:
        type: string
        format: timestamp
      job:
        type: string

  Post:
    type: object
    required:
      - id
    properties:
      id:
        type: integer
        format: int64
      id_user:
        type: integer
        format: int64
      id_network:
        type: integer
        format: int64
      post_date:
        type: string
        format: timestamp
      post_text:
        type: string
      post_class:
        type: integer
        description: Not sure what this is.
      post_original:
        type: string
        description: Not sure what this is.
      vid_link:
        type: string
      img_link:
        type: string

  NewPost:
    description: The required fields for a new post.
    type: object
    properties:
      id_user:
        type: integer
        format: int64
      id_network:
        type: integer
        format: int64
      post_text:
        type: string
      vid_link:
        type: string
      img_link:
        type: string

  PostReply:
    type: object
    required:
      - id
    properties:
      id:
        type: integer
        format: int64
      id_parent:
        type: integer
        format: int64
        description: The ID of the parent post (or post reply?)
      id_user:
        type: integer
        format: int64
      id_network:
        type: integer
        format: int64
      reply_date:
        type: string
        format: timestamp
      reply_text:
        type: string

  NewPostReply:
    description: Fields needed to make a new post reply
    type: object
    properties:
      id_parent:
        type: integer
        format: int64
        description: The ID of the parent post (or post reply?)
      id_user:
        type: integer
        format: int64
      id_network:
        type: integer
        format: int64
      reply_text:
        type: string

  Location:
    type: object
    required:
      - country_id
    description: |
      A location is defined by a tuple (country_id, region_id, city_id),
      where at least one of them must be specified.  Valid locations
      are fully specified prefixes of the tuple, since suffixes
      can be auto-completed.
    properties:
      country_id:
        type: integer
        format: int64
      region_id:
        type: integer
        format: int64
      city_id:
        type: integer
        format: int64
      name:
        type: string
  City:
    type: object
    required:
      - id
    description: |
      A city.
    properties:
      id:
        type: integer
        format: bigint20
      name:
        type: string
      latitude:
        type: number
        format: float
      longitude:
        type: number
        format: float
      region_id:
        type: integer
        format: bigint20
      region_name:
        type: string
      country_id:
        type: integer
        format: bigint20
      country_name:
        type: string
      population:
        type: integer
      feature_code:
        type: string
        description: Not sure what this is.
      tweet_terms:
        type: string
        description: Not sure what this is.

  Region:
    type: object
    required:
      - id
    description: |
      A region.
    properties:
      id:
        type: integer
        format: bigint20
      name:
        type: string
      latitude:
        type: number
        format: float
      longitude:
        type: number
        format: float
      country_id:
        type: integer
        format: bigint20
      country_name:
        type: string
      population:
        type: integer
      feature_code:
        type: string
        description: Not sure what this is.

  Country:
    type: object
    required:
      - id
    description: |
      A country.
    properties:
      id:
        type: integer
        format: bigint20
      iso_a2:
        type: integer
        description: Not sure what this is.
      name:
        type: string
      latitude:
        type: number
        format: float
      longitude:
        type: number
        format: float
      population:
        type: integer
      feature_code:
        type: string
        description: Not sure what this is.

  Language:
    type: object
    required:
      - id
    description: |
      A language.
    properties:
      id:
        type: integer
        format: bigint20
      name:
        type: string
      num_speakers:
        type: integer
        format: int4
      added:
        type: integer
        format: smallint
        description: Not sure what this is.
  verify_account:
    type: integer