openapi: 3.2.0
info:
  title: Hostfully Property Descriptions API
  license:
    name: Apache 2.0
    url: https://www.hostfully.com/
  version: v3.0.1
servers:
- url: https://sandbox-api.hostfully.com
security:
- JWT-Authentication: []
- Agency-API-key: []
tags:
- name: Property Descriptions
paths:
  /api/v3.3/property-descriptions/{propertyUid}:
    put:
      tags:
      - Property Descriptions
      summary: Update property description
      description: Creates or updates a property description for a specific locale
      operationId: put_5
      parameters:
      - name: propertyUid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropertyDescriptionUpdatingApi3Dto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PropertyDescriptionApiResponseWrapper'
    delete:
      tags:
      - Property Descriptions
      summary: Delete property description
      description: Removes the description of a property. The description is identified by 'propertyUid' and 'locale'
      operationId: delete_5
      parameters:
      - name: propertyUid
        in: path
        required: true
        schema:
          type: string
      - name: locale
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
  /api/v3.3/property-descriptions:
    get:
      tags:
      - Property Descriptions
      summary: Get property descriptions
      description: Retrieves all descriptions for a property in all available languages
      operationId: getAll_5
      parameters:
      - name: propertyUid
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PropertyDescriptionsApiResponseWrapper'
components:
  schemas:
    PropertyDescriptionUpdatingApi3Dto:
      required:
      - locale
      type: object
      properties:
        name:
          type: string
          description: Optional field, max size is 255
        shortSummary:
          type: string
          description: Optional field, max size is 255
        summary:
          type: string
          description: Optional field, max size is 500
        notes:
          type: string
        access:
          type: string
        transit:
          type: string
        interaction:
          type: string
        neighbourhood:
          type: string
        space:
          type: string
        houseManual:
          type: string
        locale:
          type: string
          description: Currently supported locales
          enum:
          - en_US
          - fr_FR
          - es_ES
          - de_DE
          - nl_NL
          - pt_PT
          - pl_PL
          - ko_KR
          - no_NO
          - zh_CH
        propertyUid:
          type: string
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    PropertyDescriptionApiResponseWrapper:
      type: object
      properties:
        propertyDescription:
          $ref: '#/components/schemas/PropertyDescriptionApi3Dto'
    PropertyDescriptionApi3Dto:
      required:
      - locale
      type: object
      properties:
        name:
          type: string
        shortSummary:
          type: string
        summary:
          type: string
        notes:
          type: string
        access:
          type: string
        transit:
          type: string
        interaction:
          type: string
        neighbourhood:
          type: string
        space:
          type: string
        houseManual:
          type: string
        locale:
          type: string
          description: Currently supported locales
          enum:
          - en_US
          - fr_FR
          - es_ES
          - de_DE
          - nl_NL
          - pt_PT
          - pl_PL
          - ko_KR
          - no_NO
          - zh_CN
          - it_IT
        propertyUid:
          type: string
    PropertyDescriptionsApiResponseWrapper:
      type: object
      properties:
        propertyDescriptions:
          type: array
          items:
            $ref: '#/components/schemas/PropertyDescriptionApi3Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
  securitySchemes:
    JWT-Authentication:
      type: apiKey
      description: OAuth Access Token
      name: Authorization
      in: header
    Agency-API-key:
      type: apiKey
      description: API Key
      name: X-HOSTFULLY-APIKEY
      in: header
externalDocs:
  description: Hostfully Documentation
  url: https://dev.hostfully.com/v3.0/reference
x-readme:
  explorer-enabled: true
  proxy-enabled: true