openapi.yaml

definitions:
  AttributionShowResponse:
    properties:
      attributionHtml:
        type: string
      attributionPlain:
        type: string
      licenseId:
        type: string
      licenseUrl:
        type: string
    required:
      - attributionHtml
      - attributionPlain
      - licenseId
      - licenseUrl
  BadRequestErrorResponse:
    description: Bad Request
    properties: {}
  CodeNameUrlGroupsModel:
    properties:
      code:
        type: string
      groups:
        items:
          type: string
        type: array
      name:
        type: string
      url:
        type: string
    required:
      - code
      - name
      - url
      - groups
  InfoShowResponse:
    properties:
      version:
        example:
          value: 1.0.0
        type: string
    required:
      - version
  InternalServerError:
    description: Internal Server Error
    properties: {}
  LicenseAuthorHtmlAttributionHtmlMediaTypeModel:
    properties:
      attributionHtml:
        type: string
      authorHtml:
        type: string
      license:
        $ref: '#/definitions/CodeNameUrlGroupsModel'
      mediaType:
        type: string
    required:
      - mediaType
  RawUrlWidthHeightModel:
    properties:
      height:
        type: integer
      rawUrl:
        type: string
      width:
        type: integer
    required:
      - rawUrl
      - width
      - height
  ServiceUnavailableErrorResponse:
    description: Service Unavailable
    properties: {}
  TitleDescriptionUrlRawUrlFileSizeThumbnailModel:
    properties:
      descriptionUrl:
        type: string
      fileSize:
        type: integer
      rawUrl:
        type: string
      thumbnail:
        $ref: '#/definitions/RawUrlWidthHeightModel'
      title:
        type: string
    required:
      - title
      - descriptionUrl
      - rawUrl
      - fileSize
      - thumbnail
  UnprocessableEntityErrorResponse:
    description: Unprocessable Entity
    properties: {}
host: 'localhost:8080'
info:
  description: Create attribution hints for images from Wikipedia and Wikimedia Commons.
  title: attribution-generator-api
  version: 0.1.0
paths:
  '/attribution/{languageCode}/{file}/{typeOfUse}/modified/{modification}/{modificationAuthor}/{licenseId}':
    get:
      description: Generate attribution hints for the given file if that file was modified.
      operationId: attribution.modified.show
      parameters:
        - in: path
          name: languageCode
          required: true
          type: string
        - in: path
          name: file
          required: true
          type: string
        - in: path
          name: typeOfUse
          required: true
          type: string
        - in: path
          name: modification
          required: true
          type: string
        - in: path
          name: modificationAuthor
          required: true
          type: string
        - in: path
          name: licenseId
          required: true
          type: string
      produces:
        - application/json
      responses:
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/BadRequestErrorResponse'
        '422':
          description: Unprocessable Entity
          schema:
            $ref: '#/definitions/UnprocessableEntityErrorResponse'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/InternalServerError'
        '503':
          description: Service Unavailable
          schema:
            $ref: '#/definitions/ServiceUnavailableErrorResponse'
        default:
          description: ''
          schema:
            $ref: '#/definitions/AttributionShowResponse'
      security:
        - default: []
      summary: Generate attribution for a modified work
      tags:
        - attribution
  '/attribution/{languageCode}/{file}/{typeOfUse}/unmodified':
    get:
      description: Generate attribution hints for the given file.
      operationId: attribution.unmodified.show
      parameters:
        - in: path
          name: languageCode
          required: true
          type: string
        - in: path
          name: file
          required: true
          type: string
        - in: path
          name: typeOfUse
          required: true
          type: string
      produces:
        - application/json
      responses:
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/BadRequestErrorResponse'
        '422':
          description: Unprocessable Entity
          schema:
            $ref: '#/definitions/UnprocessableEntityErrorResponse'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/InternalServerError'
        '503':
          description: Service Unavailable
          schema:
            $ref: '#/definitions/ServiceUnavailableErrorResponse'
        default:
          description: ''
          schema:
            $ref: '#/definitions/AttributionShowResponse'
      security:
        - default: []
      summary: Generate attribution
      tags:
        - attribution
  /docs:
    get:
      produces:
        - application/json
      responses:
        default:
          description: ''
      tags:
        - docs
  /docs/index.html:
    get:
      produces:
        - application/json
      responses:
        default:
          description: ''
      tags:
        - docs
  '/docs/{path}':
    get:
      produces:
        - application/json
      responses:
        default:
          description: ''
      tags:
        - docs
  '/fileinfo/{fileUrlOrTitle}':
    get:
      description: Returns the most liberal license for the given image
      parameters:
        - in: path
          name: fileUrlOrTitle
          required: true
          type: string
      produces:
        - application/json
      responses:
        '422':
          description: Unprocessable Entity
          schema:
            $ref: '#/definitions/UnprocessableEntityErrorResponse'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/InternalServerError'
        '503':
          description: Service Unavailable
          schema:
            $ref: '#/definitions/ServiceUnavailableErrorResponse'
        default:
          description: ''
          schema:
            $ref: '#/definitions/LicenseAuthorHtmlAttributionHtmlMediaTypeModel'
      summary: Image license
      tags:
        - fileinfo
  '/files/{articleUrl}':
    get:
      description: Retrieve all files for a given article or page url.
      operationId: files.index
      parameters:
        - in: path
          name: articleUrl
          required: true
          type: string
      produces:
        - application/json
      responses:
        '422':
          description: Unprocessable Entity
          schema:
            $ref: '#/definitions/UnprocessableEntityErrorResponse'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/InternalServerError'
        '503':
          description: Service Unavailable
          schema:
            $ref: '#/definitions/ServiceUnavailableErrorResponse'
        default:
          description: ''
          schema:
            items:
              $ref: '#/definitions/TitleDescriptionUrlRawUrlFileSizeThumbnailModel'
            type: array
      security:
        - default: []
      summary: Get all files for an article
      tags:
        - files
  /info:
    get:
      description: Get information on the API.
      operationId: info.show
      produces:
        - application/json
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/InfoShowResponse'
      summary: Get information
      tags:
        - info
  /licenses:
    get:
      description: Returns a list of all licenses
      produces:
        - application/json
      responses:
        default:
          description: ''
          schema:
            items:
              $ref: '#/definitions/CodeNameUrlGroupsModel'
            type: array
      summary: Licenses index
      tags:
        - licenses
  '/licenses/compatible/{licenseId}':
    get:
      description: Returns a list of licenses that are compatible to the passed license ID
      parameters:
        - in: path
          name: licenseId
          required: true
          type: string
      produces:
        - application/json
      responses:
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/InternalServerError'
        default:
          description: ''
          schema:
            items:
              $ref: '#/definitions/CodeNameUrlGroupsModel'
            type: array
      summary: Compatible licenses
      tags:
        - licenses
  /swagger:
    get:
      parameters:
        - in: query
          name: tags
          required: false
          type: string
      produces:
        - application/json
      responses:
        default:
          description: ''
      tags:
        - swagger
schemes:
  - http
  - https
securityDefinitions: {}
swagger: '2.0'
tags: []