openapi: 3.0.3
info:
  title: 'API documentation for Diesel Docs'
  description: ''
  version: 1.0.0
servers:
  -
    url: 'https://api-dieseldocs.com'
paths:
  '/api/v1/{uid}/usage-stats':
    get:
      summary: 'Usage stats'
      description: 'View a subscriber''s document usage stats.'
      parameters:
        -
          in: query
          name: verbose
          description: 'If set to true, the "usage.used" array will contain full document data instead of just IDs.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'If set to true, the "usage.used" array will contain full document data instead of just IDs.'
            example: true
        -
          in: query
          name: type
          description: "Type of the user. Possible values: 'DL', 'X'\n(for DL-Authorization and X-Authorization correspondingly). Default: 'DL'."
          example: DL
          required: false
          schema:
            type: string
            description: "Type of the user. Possible values: 'DL', 'X'\n(for DL-Authorization and X-Authorization correspondingly). Default: 'DL'."
            example: DL
        -
          in: header
          name: Content-Type
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: Accept
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: DL-Authorization
          description: ''
          example: '{YOUR_API_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  meta:
                    usage:
                      used: []
                      max: 2
                properties:
                  meta:
                    type: object
                    example:
                      usage:
                        used: []
                        max: 2
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - Document
      security: []
    parameters:
      -
        in: path
        name: uid
        description: ''
        example: molestiae
        required: true
        schema:
          type: string
      -
        in: path
        name: subscriber_uid
        description: 'Optional parameter. ''ID'' of the subscriber.'
        required: true
        schema:
          type: string
        examples:
          omitted:
            summary: 'When the value is omitted'
            value: ''
          present:
            summary: 'When the value is present'
            value: exercitationem
  /api/v1/document:
    get:
      summary: List
      description: 'Retrieve all documents'
      parameters:
        -
          in: query
          name: subscriber_uid
          description: '''ID'' of the customer. It must be specified to generate URL of the document.'
          example: impedit
          required: false
          schema:
            type: string
            description: '''ID'' of the customer. It must be specified to generate URL of the document.'
            example: impedit
        -
          in: query
          name: document_type_id
          description: '''ID'' of the document type to search.'
          example: 8
          required: false
          schema:
            type: integer
            description: '''ID'' of the document type to search.'
            example: 8
        -
          in: query
          name: system_type_id
          description: '''ID'' of the system type to search.'
          example: 14
          required: false
          schema:
            type: integer
            description: '''ID'' of the system type to search.'
            example: 14
        -
          in: query
          name: not_categorized
          description: 'Retrieve only not categorized documents.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Retrieve only not categorized documents.'
            example: true
        -
          in: query
          name: sort_by
          description: 'Field to sort by. Defaults to ''name''. Possible values: ''name''.'
          example: name
          required: false
          schema:
            type: string
            description: 'Field to sort by. Defaults to ''name''. Possible values: ''name''.'
            example: name
        -
          in: query
          name: sort_dir
          description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
          example: asc
          required: false
          schema:
            type: string
            description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
            example: asc
        -
          in: query
          name: page
          description: 'Page of result to return. Defaults to 1.'
          example: 11
          required: false
          schema:
            type: integer
            description: 'Page of result to return. Defaults to 1.'
            example: 11
        -
          in: query
          name: per_page
          description: 'How many rows to return per page. Defaults to 10, maximum 100.'
          example: 20
          required: false
          schema:
            type: integer
            description: 'How many rows to return per page. Defaults to 10, maximum 100.'
            example: 20
        -
          in: header
          name: Content-Type
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: Accept
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: DL-Authorization
          description: ''
          example: '{YOUR_API_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 10
                      document_type_id: 15
                      name: 'Cummins - B6.7 - 2012-2015.PDF'
                      token: A2ZF...
                      preview_url: 'https://api-dieseldocs.com/api/v1/document/A2ZF.../preview?cache-buster=1584024861'
                      preview_pages: '1'
                      dependencies:
                        documentType:
                          id: 15
                          model_id: 7
                          name: Instruction
                        model:
                          id: 7
                          year_id: 4
                          name: B6.7
                        year:
                          id: 4
                          type_id: 1
                          name: 2012-2015
                        type:
                          id: 1
                          make_id: 1
                          name: Engine
                        make:
                          id: 1
                          industry_id: 1
                          name: Cummins
                        industry:
                          id: 1
                          name: 'On Highway'
                      url: ''
                  links:
                    first: 'https://api-dieseldocs.com/api/v1/document?page=1'
                    last: 'https://api-dieseldocs.com/api/v1/document?page=1'
                    prev: null
                    next: null
                  meta:
                    current_page: 1
                    from: 1
                    last_page: 1
                    path: 'https://api-dieseldocs.com/api/v1/document'
                    per_page: 10
                    to: 9
                    total: 9
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 10
                        document_type_id: 15
                        name: 'Cummins - B6.7 - 2012-2015.PDF'
                        token: A2ZF...
                        preview_url: 'https://api-dieseldocs.com/api/v1/document/A2ZF.../preview?cache-buster=1584024861'
                        preview_pages: '1'
                        dependencies:
                          documentType:
                            id: 15
                            model_id: 7
                            name: Instruction
                          model:
                            id: 7
                            year_id: 4
                            name: B6.7
                          year:
                            id: 4
                            type_id: 1
                            name: 2012-2015
                          type:
                            id: 1
                            make_id: 1
                            name: Engine
                          make:
                            id: 1
                            industry_id: 1
                            name: Cummins
                          industry:
                            id: 1
                            name: 'On Highway'
                        url: ''
                    items:
                      type: object
                  links:
                    type: object
                    example:
                      first: 'https://api-dieseldocs.com/api/v1/document?page=1'
                      last: 'https://api-dieseldocs.com/api/v1/document?page=1'
                      prev: null
                      next: null
                  meta:
                    type: object
                    example:
                      current_page: 1
                      from: 1
                      last_page: 1
                      path: 'https://api-dieseldocs.com/api/v1/document'
                      per_page: 10
                      to: 9
                      total: 9
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - Document
      security: []
  '/api/v1/document/{id}':
    get:
      summary: Retrieve
      description: 'Retrieve the document'
      parameters:
        -
          in: query
          name: subscriber_uid
          description: '''ID'' of the customer. It must be specified to generate URL of the document.'
          example: omnis
          required: false
          schema:
            type: string
            description: '''ID'' of the customer. It must be specified to generate URL of the document.'
            example: omnis
        -
          in: header
          name: Content-Type
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: Accept
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: DL-Authorization
          description: ''
          example: '{YOUR_API_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 10
                    document_type_id: 15
                    name: 'Cummins - B6.7 - 2012-2015.PDF'
                    token: O74s...
                    preview_url: 'https://api-dieseldocs.com/api/v1/document/O74s.../preview?cache-buster=1584024375'
                    preview_pages: '1'
                    dependencies:
                      documentType:
                        id: 15
                        model_id: 7
                        name: Instruction
                      model:
                        id: 7
                        year_id: 4
                        name: B6.7
                      year:
                        id: 4
                        type_id: 1
                        name: 2012-2015
                      type:
                        id: 1
                        make_id: 1
                        name: Engine
                      make:
                        id: 1
                        industry_id: 1
                        name: Cummins
                      industry:
                        id: 1
                        name: 'On Highway'
                    url: ''
                properties:
                  data:
                    type: object
                    example:
                      id: 10
                      document_type_id: 15
                      name: 'Cummins - B6.7 - 2012-2015.PDF'
                      token: O74s...
                      preview_url: 'https://api-dieseldocs.com/api/v1/document/O74s.../preview?cache-buster=1584024375'
                      preview_pages: '1'
                      dependencies:
                        documentType:
                          id: 15
                          model_id: 7
                          name: Instruction
                        model:
                          id: 7
                          year_id: 4
                          name: B6.7
                        year:
                          id: 4
                          type_id: 1
                          name: 2012-2015
                        type:
                          id: 1
                          make_id: 1
                          name: Engine
                        make:
                          id: 1
                          industry_id: 1
                          name: Cummins
                        industry:
                          id: 1
                          name: 'On Highway'
                      url: ''
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - Document
      security: []
    parameters:
      -
        in: path
        name: id
        description: '''ID'' of the document.'
        example: 15
        required: true
        schema:
          type: integer
  '/api/v1/document/{jwt_token}/view':
    get:
      summary: 'View PDF'
      description: "View a document's PDF. NOTE: this counts towards the user's viewing quota.\n\n<aside class=\"warning\">This call returns a PDF response, not JSON</aside>"
      parameters:
        -
          in: header
          name: Content-Type
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: Accept
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: DL-Authorization
          description: ''
          example: '{YOUR_API_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example: {  }
                properties: {  }
      tags:
        - Document
      security: []
    parameters:
      -
        in: path
        name: jwt_token
        description: 'JWT encoding `token` and `subscriber_uid`.'
        example: explicabo
        required: true
        schema:
          type: string
  '/api/v1/document/{token}/preview':
    get:
      summary: 'Preview PDF'
      description: "<aside class=\"warning\">This call returns a PDF response, not JSON</aside>\n\nPreview PDF file"
      parameters:
        -
          in: header
          name: Content-Type
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: Accept
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: DL-Authorization
          description: ''
          example: '{YOUR_API_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example: {  }
                properties: {  }
      tags:
        - Document
      security: []
    parameters:
      -
        in: path
        name: token
        description: 'Optional parameter. Token returned in the document data (`preview_url` field).'
        required: true
        schema:
          type: string
        examples:
          omitted:
            summary: 'When the value is omitted'
            value: ''
          present:
            summary: 'When the value is present'
            value: saepe
  /api/v1/document-type:
    get:
      summary: List
      description: 'Retrieve all document types'
      parameters:
        -
          in: query
          name: model_id
          description: 'Filter by ''ID'' of the model.'
          example: 17
          required: false
          schema:
            type: integer
            description: 'Filter by ''ID'' of the model.'
            example: 17
        -
          in: query
          name: sort_by
          description: 'Field to sort by. Defaults to ''name''. Possible values: ''name''.'
          example: name
          required: false
          schema:
            type: string
            description: 'Field to sort by. Defaults to ''name''. Possible values: ''name''.'
            example: name
        -
          in: query
          name: sort_dir
          description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
          example: asc
          required: false
          schema:
            type: string
            description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
            example: asc
        -
          in: query
          name: page
          description: 'Page of result to return. Defaults to 1.'
          example: 17
          required: false
          schema:
            type: integer
            description: 'Page of result to return. Defaults to 1.'
            example: 17
        -
          in: query
          name: per_page
          description: 'How many rows to return per page. Defaults to 300, maximum 300.'
          example: 20
          required: false
          schema:
            type: integer
            description: 'How many rows to return per page. Defaults to 300, maximum 300.'
            example: 20
        -
          in: header
          name: Content-Type
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: Accept
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: DL-Authorization
          description: ''
          example: '{YOUR_API_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 1
                      model_id: 1
                      name: Instruction
                  links:
                    first: 'http://api-dieseldocs.com/api/v1/document-type?page=1'
                    last: 'http://api-dieseldocs.com/api/v1/document-type?page=1'
                    prev: null
                    next: null
                  meta:
                    current_page: 1
                    from: null
                    last_page: 1
                    path: 'http://api-dieseldocs.com/api/v1/document-type'
                    per_page: 300
                    to: null
                    total: 0
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 1
                        model_id: 1
                        name: Instruction
                    items:
                      type: object
                  links:
                    type: object
                    example:
                      first: 'http://api-dieseldocs.com/api/v1/document-type?page=1'
                      last: 'http://api-dieseldocs.com/api/v1/document-type?page=1'
                      prev: null
                      next: null
                  meta:
                    type: object
                    example:
                      current_page: 1
                      from: null
                      last_page: 1
                      path: 'http://api-dieseldocs.com/api/v1/document-type'
                      per_page: 300
                      to: null
                      total: 0
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - 'Document Type'
      security: []
  /api/v1/industry:
    get:
      summary: List
      description: 'Retrieve all industries'
      parameters:
        -
          in: query
          name: sort_by
          description: 'Field to sort by. Defaults to ''name''. Possible values: ''name''.'
          example: name
          required: false
          schema:
            type: string
            description: 'Field to sort by. Defaults to ''name''. Possible values: ''name''.'
            example: name
        -
          in: query
          name: sort_dir
          description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
          example: asc
          required: false
          schema:
            type: string
            description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
            example: asc
        -
          in: query
          name: page
          description: 'Page of result to return. Defaults to 1.'
          example: 4
          required: false
          schema:
            type: integer
            description: 'Page of result to return. Defaults to 1.'
            example: 4
        -
          in: query
          name: per_page
          description: 'How many rows to return per page. Defaults to 300, maximum 300.'
          example: 20
          required: false
          schema:
            type: integer
            description: 'How many rows to return per page. Defaults to 300, maximum 300.'
            example: 20
        -
          in: header
          name: Content-Type
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: Accept
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: DL-Authorization
          description: ''
          example: '{YOUR_API_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 1
                      name: 'On Highway'
                  links:
                    first: 'http://api-dieseldocs.com/api/v1/industry?page=1'
                    last: 'http://api-dieseldocs.com/api/v1/industry?page=1'
                    prev: null
                    next: null
                  meta:
                    current_page: 1
                    from: 1
                    last_page: 1
                    path: 'http://api-dieseldocs.com/api/v1/industry'
                    per_page: 300
                    to: 4
                    total: 4
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 1
                        name: 'On Highway'
                    items:
                      type: object
                  links:
                    type: object
                    example:
                      first: 'http://api-dieseldocs.com/api/v1/industry?page=1'
                      last: 'http://api-dieseldocs.com/api/v1/industry?page=1'
                      prev: null
                      next: null
                  meta:
                    type: object
                    example:
                      current_page: 1
                      from: 1
                      last_page: 1
                      path: 'http://api-dieseldocs.com/api/v1/industry'
                      per_page: 300
                      to: 4
                      total: 4
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - Industry
      security: []
  /api/v1/make:
    get:
      summary: List
      description: 'Retrieve all makes'
      parameters:
        -
          in: query
          name: industry_id
          description: '''ID'' of the industry.'
          example: 2
          required: false
          schema:
            type: integer
            description: '''ID'' of the industry.'
            example: 2
        -
          in: query
          name: sort_by
          description: 'Field to sort by. Defaults to ''name''. Possible values: ''name''.'
          example: name
          required: false
          schema:
            type: string
            description: 'Field to sort by. Defaults to ''name''. Possible values: ''name''.'
            example: name
        -
          in: query
          name: sort_dir
          description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
          example: asc
          required: false
          schema:
            type: string
            description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
            example: asc
        -
          in: query
          name: page
          description: 'Page of result to return. Defaults to 1.'
          example: 18
          required: false
          schema:
            type: integer
            description: 'Page of result to return. Defaults to 1.'
            example: 18
        -
          in: query
          name: per_page
          description: 'How many rows to return per page. Defaults to 300, maximum 300.'
          example: 20
          required: false
          schema:
            type: integer
            description: 'How many rows to return per page. Defaults to 300, maximum 300.'
            example: 20
        -
          in: header
          name: Content-Type
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: Accept
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: DL-Authorization
          description: ''
          example: '{YOUR_API_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 1
                      industry_id: 1
                      name: Cummins
                  links:
                    first: 'http://api-dieseldocs.com/api/v1/make?page=1'
                    last: 'http://api-dieseldocs.com/api/v1/make?page=1'
                    prev: null
                    next: null
                  meta:
                    current_page: 1
                    from: null
                    last_page: 1
                    path: 'http://api-dieseldocs.com/api/v1/make'
                    per_page: 300
                    to: null
                    total: 0
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 1
                        industry_id: 1
                        name: Cummins
                    items:
                      type: object
                  links:
                    type: object
                    example:
                      first: 'http://api-dieseldocs.com/api/v1/make?page=1'
                      last: 'http://api-dieseldocs.com/api/v1/make?page=1'
                      prev: null
                      next: null
                  meta:
                    type: object
                    example:
                      current_page: 1
                      from: null
                      last_page: 1
                      path: 'http://api-dieseldocs.com/api/v1/make'
                      per_page: 300
                      to: null
                      total: 0
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - Make
      security: []
  /api/v1/model:
    get:
      summary: List
      description: 'Retrieve all models'
      parameters:
        -
          in: query
          name: year_id
          description: 'Filter by the ''ID'' of the year.'
          example: 18
          required: false
          schema:
            type: integer
            description: 'Filter by the ''ID'' of the year.'
            example: 18
        -
          in: query
          name: sort_by
          description: 'Field to sort by. Defaults to ''name''. Possible values: ''name''.'
          example: name
          required: false
          schema:
            type: string
            description: 'Field to sort by. Defaults to ''name''. Possible values: ''name''.'
            example: name
        -
          in: query
          name: sort_dir
          description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
          example: asc
          required: false
          schema:
            type: string
            description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
            example: asc
        -
          in: query
          name: page
          description: 'Page of result to return. Defaults to 1.'
          example: 6
          required: false
          schema:
            type: integer
            description: 'Page of result to return. Defaults to 1.'
            example: 6
        -
          in: query
          name: per_page
          description: 'How many rows to return per page. Defaults to 300, maximum 300.'
          example: 20
          required: false
          schema:
            type: integer
            description: 'How many rows to return per page. Defaults to 300, maximum 300.'
            example: 20
        -
          in: header
          name: Content-Type
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: Accept
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: DL-Authorization
          description: ''
          example: '{YOUR_API_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 1
                      year_id: 1
                      name: B6.7
                  links:
                    first: 'http://api-dieseldocs.com/api/v1/model?page=1'
                    last: 'http://api-dieseldocs.com/api/v1/model?page=1'
                    prev: null
                    next: null
                  meta:
                    current_page: 1
                    from: null
                    last_page: 1
                    path: 'http://api-dieseldocs.com/api/v1/model'
                    per_page: 300
                    to: null
                    total: 0
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 1
                        year_id: 1
                        name: B6.7
                    items:
                      type: object
                  links:
                    type: object
                    example:
                      first: 'http://api-dieseldocs.com/api/v1/model?page=1'
                      last: 'http://api-dieseldocs.com/api/v1/model?page=1'
                      prev: null
                      next: null
                  meta:
                    type: object
                    example:
                      current_page: 1
                      from: null
                      last_page: 1
                      path: 'http://api-dieseldocs.com/api/v1/model'
                      per_page: 300
                      to: null
                      total: 0
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - Model
      security: []
  /api/v1/system-type:
    get:
      summary: List
      description: 'Retrieve all system types'
      parameters:
        -
          in: query
          name: document_type_id
          description: '''ID'' of the document type.'
          example: 3
          required: false
          schema:
            type: integer
            description: '''ID'' of the document type.'
            example: 3
        -
          in: query
          name: sort_by
          description: 'Field to sort by. Defaults to ''name''. Possible values: ''name''.'
          example: name
          required: false
          schema:
            type: string
            description: 'Field to sort by. Defaults to ''name''. Possible values: ''name''.'
            example: name
        -
          in: query
          name: sort_dir
          description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
          example: asc
          required: false
          schema:
            type: string
            description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
            example: asc
        -
          in: query
          name: page
          description: 'Page of result to return. Defaults to 1.'
          example: 18
          required: false
          schema:
            type: integer
            description: 'Page of result to return. Defaults to 1.'
            example: 18
        -
          in: query
          name: per_page
          description: 'How many rows to return per page. Defaults to 300, maximum 300.'
          example: 20
          required: false
          schema:
            type: integer
            description: 'How many rows to return per page. Defaults to 300, maximum 300.'
            example: 20
        -
          in: header
          name: Content-Type
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: Accept
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: DL-Authorization
          description: ''
          example: '{YOUR_API_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 66744
                      document_type_id: 8516
                      name: 20V689000
                  links:
                    first: 'https://api-dieseldocs.com/api/v1/system-type?page=1'
                    last: 'https://api-dieseldocs.com/api/v1/system-type?page=1'
                    prev: null
                    next: null
                  meta:
                    current_page: 1
                    from: 1
                    last_page: 1
                    path: 'https://api-dieseldocs.com/api/v1/system-type'
                    per_page: 300
                    to: 1
                    total: 1
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 66744
                        document_type_id: 8516
                        name: 20V689000
                    items:
                      type: object
                  links:
                    type: object
                    example:
                      first: 'https://api-dieseldocs.com/api/v1/system-type?page=1'
                      last: 'https://api-dieseldocs.com/api/v1/system-type?page=1'
                      prev: null
                      next: null
                  meta:
                    type: object
                    example:
                      current_page: 1
                      from: 1
                      last_page: 1
                      path: 'https://api-dieseldocs.com/api/v1/system-type'
                      per_page: 300
                      to: 1
                      total: 1
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - 'System Type'
      security: []
  /api/v1/type:
    get:
      summary: List
      description: 'Retrieve all types ''ID'' of the make'
      parameters:
        -
          in: query
          name: make_id
          description: 'Filter by the ''ID'' of the make.'
          example: 19
          required: false
          schema:
            type: integer
            description: 'Filter by the ''ID'' of the make.'
            example: 19
        -
          in: query
          name: sort_by
          description: 'Field to sort by. Defaults to ''name''. Possible values: ''name''.'
          example: name
          required: false
          schema:
            type: string
            description: 'Field to sort by. Defaults to ''name''. Possible values: ''name''.'
            example: name
        -
          in: query
          name: sort_dir
          description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
          example: asc
          required: false
          schema:
            type: string
            description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
            example: asc
        -
          in: query
          name: page
          description: 'Page of result to return. Defaults to 1.'
          example: 14
          required: false
          schema:
            type: integer
            description: 'Page of result to return. Defaults to 1.'
            example: 14
        -
          in: query
          name: per_page
          description: 'How many rows to return per page. Defaults to 300, maximum 300.'
          example: 20
          required: false
          schema:
            type: integer
            description: 'How many rows to return per page. Defaults to 300, maximum 300.'
            example: 20
        -
          in: header
          name: Content-Type
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: Accept
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: DL-Authorization
          description: ''
          example: '{YOUR_API_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 1
                      make_id: 1
                      name: Engine
                  links:
                    first: 'http://api-dieseldocs.com/api/v1/type?page=1'
                    last: 'http://api-dieseldocs.com/api/v1/type?page=1'
                    prev: null
                    next: null
                  meta:
                    current_page: 1
                    from: null
                    last_page: 1
                    path: 'http://api-dieseldocs.com/api/v1/type'
                    per_page: 300
                    to: null
                    total: 0
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 1
                        make_id: 1
                        name: Engine
                    items:
                      type: object
                  links:
                    type: object
                    example:
                      first: 'http://api-dieseldocs.com/api/v1/type?page=1'
                      last: 'http://api-dieseldocs.com/api/v1/type?page=1'
                      prev: null
                      next: null
                  meta:
                    type: object
                    example:
                      current_page: 1
                      from: null
                      last_page: 1
                      path: 'http://api-dieseldocs.com/api/v1/type'
                      per_page: 300
                      to: null
                      total: 0
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - Type
      security: []
  /api/v1/year:
    get:
      summary: List
      description: 'Retrieve all years'
      parameters:
        -
          in: query
          name: type_id
          description: 'Filter by the ''ID'' of the type.'
          example: 13
          required: false
          schema:
            type: integer
            description: 'Filter by the ''ID'' of the type.'
            example: 13
        -
          in: query
          name: sort_by
          description: 'Field to sort by. Defaults to ''name''. Possible values: ''name''.'
          example: name
          required: false
          schema:
            type: string
            description: 'Field to sort by. Defaults to ''name''. Possible values: ''name''.'
            example: name
        -
          in: query
          name: sort_dir
          description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
          example: asc
          required: false
          schema:
            type: string
            description: 'Sort direction. Defaults to ''asc''. Possible values: ''asc'' or ''desc''.'
            example: asc
        -
          in: query
          name: page
          description: 'Page of result to return. Defaults to 1.'
          example: 4
          required: false
          schema:
            type: integer
            description: 'Page of result to return. Defaults to 1.'
            example: 4
        -
          in: query
          name: per_page
          description: 'How many rows to return per page. Defaults to 300, maximum 300.'
          example: 20
          required: false
          schema:
            type: integer
            description: 'How many rows to return per page. Defaults to 300, maximum 300.'
            example: 20
        -
          in: header
          name: Content-Type
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: Accept
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: DL-Authorization
          description: ''
          example: '{YOUR_API_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 1
                      type_id: 1
                      name: 2017-2019
                  links:
                    first: 'http://api-dieseldocs.com/api/v1/year?page=1'
                    last: 'http://api-dieseldocs.com/api/v1/year?page=1'
                    prev: null
                    next: null
                  meta:
                    current_page: 1
                    from: null
                    last_page: 1
                    path: 'http://api-dieseldocs.com/api/v1/year'
                    per_page: 300
                    to: null
                    total: 0
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 1
                        type_id: 1
                        name: 2017-2019
                    items:
                      type: object
                  links:
                    type: object
                    example:
                      first: 'http://api-dieseldocs.com/api/v1/year?page=1'
                      last: 'http://api-dieseldocs.com/api/v1/year?page=1'
                      prev: null
                      next: null
                  meta:
                    type: object
                    example:
                      current_page: 1
                      from: null
                      last_page: 1
                      path: 'http://api-dieseldocs.com/api/v1/year'
                      per_page: 300
                      to: null
                      total: 0
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - Year
      security: []
tags:
  -
    name: Document
    description: ''
  -
    name: 'Document Type'
    description: ''
  -
    name: Industry
    description: ''
  -
    name: Make
    description: ''
  -
    name: Model
    description: ''
  -
    name: 'System Type'
    description: ''
  -
    name: Type
    description: ''
  -
    name: Year
    description: ''
