api.yaml

swagger: "2.0"
info:
  version: 1.0.0
  title: Test API
  description: Test API.
host: localhost
basePath: /api/v1
schemes:
  - https
securityDefinitions:
  bearerToken:
    type: apiKey
    name: Authorization
    in: header
paths:
  /test-auth-bearer:
    get:
      operationId: "testAuthBearer"
      security:
        - bearerToken: []
      parameters:
        - name: "qo"
          in: "query"
          required: false
          type: "string"
        - name: "qr"
          in: "query"
          required: true
          type: "string"
      responses:
        "200":
          description: "Will send `Authenticated`"
        "403":
          description: "You do not have necessary permissions for the resource"
  /test-file-upload:
    post:
      operationId: "testFileUpload"
      consumes:
        - multipart/form-data
      parameters:
        - name: "file"
          in: "formData"
          type: "file"
          required: true
      responses:
        "200":
          description: "File uploaded"
  /test-serializers:
    post:
      operationId: "testSerializer"
      parameters:
        - name: "qo"
          in: "query"
          required: false
          type: "string"
      responses:
        "200":
          description: "File uploaded"
          schema:
            $ref: "#/definitions/Message"
        "403":
          description: "Error string"
          schema:
            $ref: "#/definitions/Problem"
definitions:
  Problem:
    properties:
      title:
        type: string
      type:
        type: string
  AllOfTest:
    allOf:
      - type: object
        properties:
          items:
            type: array
            items:
              $ref: "#/definitions/Message"
      - $ref: "#/definitions/PaginationResponse"
  AllOfOneOfTest:
    description: test if we can use allOf as oneOf
    x-one-of: true
    allOf:
      - type: object
        properties:
          items:
            type: array
            items:
              $ref: "#/definitions/Message"
      - $ref: "#/definitions/PaginationResponse"
  OneOfTest:
    oneOf:
      - type: object
        properties:
          limited:
            type: boolean
      - type: object
        properties:
          unlimited:
            type: boolean
  AdditionalPropsTest:
    type: object
    additionalProperties:
      type: array
      items:
        type: number
  AdditionalpropsDefault:
    type: object
    default: { "test": [1000] }
    additionalProperties:
      type: array
      items:
        type: number
  AdditionalPropsTrueTest:
    type: object
    additionalProperties: true
  NonNegativeNumberTest:
    title: NonNegativeNumberTest
    type: number
    minimum: 0
  WithinRangeStringTest:
    title: WithinRangeStringTest
    type: string
    minLength: 10
    maxLength: 10
  WithinRangeNumberTest:
    title: WithinRangeNumberTest
    type: number
    minimum: 0
    maximum: 10
  InlinePropertyTest:
    type: object
    properties:
      inlineProp:
        type: string
        description: The device global unique identifier.
        pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
  CustomStringFormatTest:
    type: string
    x-import: italia-ts-commons/lib/string
    format: SomeCustomStringType
  OrganizationFiscalCode:
    type: string
    x-import: italia-ts-commons/lib/string
    format: OrganizationFiscalCode
  OrganizationFiscalCodeTest:
    type: string
    x-import: italia-ts-commons/lib/string
    format: OrganizationFiscalCode
  NonNegativeIntegerTest:
    title: NonNegativeIntegerTest
    type: integer
    minimum: 0
  WithinRangeIntegerTest:
    title: WithinRangeIntegerTest
    type: integer
    minimum: 0
    maximum: 10
  NestedObjectTest:
    type: object
    properties:
      inlineProp:
        type: string
        description: The device global unique identifier.
        pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
      nestedObject:
        type: object
        properties:
          inlineProp:
            type: string
            description: The device global unique identifier.
            pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
  EnumTest:
    type: object
    properties:
      status:
        type: string
        enum:
          - value1
          - value2
          - value3
  MessageContent:
    $ref: "https://raw.githubusercontent.com/teamdigitale/digital-citizenship-functions/v0.38.0/api/definitions.yaml#/MessageContent"
  FiscalCode:
    $ref: "https://raw.githubusercontent.com/teamdigitale/digital-citizenship-functions/v0.38.0/api/definitions.yaml#/FiscalCode"
  EmailAddress:
    $ref: "https://raw.githubusercontent.com/teamdigitale/digital-citizenship-functions/v0.38.0/api/definitions.yaml#/EmailAddress"
  ExtendedProfile:
    $ref: "https://raw.githubusercontent.com/teamdigitale/digital-citizenship-functions/v0.38.0/api/definitions.yaml#/ExtendedProfile"
  LimitedProfile:
    $ref: "https://raw.githubusercontent.com/teamdigitale/digital-citizenship-functions/v0.38.0/api/definitions.yaml#/LimitedProfile"
  PreferredLanguages:
    $ref: "https://raw.githubusercontent.com/teamdigitale/digital-citizenship-functions/v0.38.0/api/definitions.yaml#/PreferredLanguages"
  IsInboxEnabled:
    $ref: "https://raw.githubusercontent.com/teamdigitale/digital-citizenship-functions/v0.38.0/api/definitions.yaml#/IsInboxEnabled"
  IsWebhookEnabled:
    $ref: "https://raw.githubusercontent.com/teamdigitale/digital-citizenship-functions/v0.38.0/api/definitions.yaml#/IsWebhookEnabled"
  PaginationResponse:
    $ref: "https://raw.githubusercontent.com/teamdigitale/digital-citizenship-functions/v0.38.0/api/definitions.yaml#/PaginationResponse"
  CreatedMessageWithContent:
    $ref: "https://raw.githubusercontent.com/teamdigitale/digital-citizenship-functions/v0.38.0/api/definitions.yaml#/CreatedMessageWithContent"
  ServicePublic:
    $ref: "https://raw.githubusercontent.com/teamdigitale/digital-citizenship-functions/v0.38.0/api/definitions.yaml#/ServicePublic"
  Message:
    title: Message
    type: object
    properties:
      id:
        type: string
      content:
        $ref: "#/definitions/MessageContent"
      sender_service_id:
        type: string
    required:
      - id
      - content
  Profile:
    title: Profile
    description: Describes the user's profile.
    type: object
    properties:
      email:
        $ref: "#/definitions/EmailAddress"
      family_name:
        type: string
      fiscal_code:
        $ref: "#/definitions/FiscalCode"
      has_profile:
        type: boolean
      is_email_set:
        type: boolean
      is_inbox_enabled:
        $ref: "#/definitions/IsInboxEnabled"
      is_webhook_enabled:
        $ref: "#/definitions/IsWebhookEnabled"
      name:
        type: string
      preferred_email:
        $ref: "#/definitions/EmailAddress"
      preferred_languages:
        $ref: "#/definitions/PreferredLanguages"
      version:
        type: integer
      payload:
        type: object
        properties: {}
    required:
      - fiscal_code
      - family_name
      - has_profile
      - is_email_set
      - name
      - version
responses: {}
parameters:
  PaginationRequest:
    name: cursor
    in: query
    type: string
    minimum: 1
    description: An opaque identifier that points to the next item in the collection.
consumes:
  - application/json
produces:
  - application/json