Skip to content

GitLab

Open
Created by Dmytro Halinovskyi@dmytro.halinovskyiMaintainer

Add procedure base model to swagger

check and clarify the relevance of the underlying data

base.Procedure:
      type: object
      title: base.Procedure
      description: 
        'Procedure model Включає набір полів обов''язквий для всіх процедур. '   
      properties:
        owner:
          type: string
          readOnly: true
          x-legalNameUa: Ідентифікатор майданчика
          x-legalNameEn: Broker ID
        ownerToken:
          type: string
          format: uuid
          readOnly: true
        _id:
          type: string
          readOnly: true
          x-legalNameUa: Внутрішній ідентифікатор аукціону
          x-legalNameEn: ID
        datePublished:
          type: string
          format: date-time
          readOnly: true
          x-legalNameUa: Дата публікації процедури
          x-legalNameEn: Published date
        dateModified:
          type: string
          format: date-time
          readOnly: true
          x-legalNameUa: Остання дата зміни процедури
          x-legalNameEn: Procedure date modified
        spec:
          type: object
          readOnly: true
        auctionId:
          type: string
          readOnly: true
          x-legalNameUa: Ідентифікатор аукціону
          x-legalNameEn: Auction ID
        procurementMethod:
          type: string
          x-legalNameUa: Тип процедури
          x-legalNameEn: Procedure type
        procuringEntity:
          type: object
          allOf:
            - $ref: '#/components/schemas/base.ProcuringEntity'
          x-legalNameUa: Інформація про Організатора аукціону
          x-legalNameEn: Organizer information
        tenderAttempts:
          description:  |
            Якщо tenderAttempts = 1, то поле discount та previousAuctionId не використовується. Якщо tenderAttempts >1 поле discount використовується, але поле НЕ обов'язкове; поле previousAuctionId використовується та є обов'язкове   
          type: number
          format: int64
          minimum: 1
          maximum: 99 
          example: 2
          x-legalNameUa: Лот виставляється
          x-legalNameEn: Attempt number
        lotId:
          description: |
            заповнюється вручну або автогенероване з auctionId залежить від кожної окремої процедури
          type: string
          minLength: 1
          x-legalNameUa: Номер лота
          x-legalNameEn: Lot number
        previousAuctionId:
          description: |
            якщо  tenderAttempts > 1 заповнюється вручну, має відповідати auctionId попереднього аукціону. Якщо tenderAttempts = 1 то previousAuctionId не використовується
          type: string
          format: RC000-UA-YYYYMMDD-00000/UA-PS-YYYYMMDD-000000
          minLength: 1
          x-legalNameUa: Номер попереднього аукціону
          x-legalNameEn: Previous auction Id 
        title:
          type: object
          allOf:
            - $ref: '#/components/schemas/base.MultiLang'
          x-legalNameUa: Назва аукціону
          x-legalNameEn: Auction title           
        auctionUrl:
          type: string
          readOnly: true
          example: /api/auctions/123
          x-legalNameUa: Веб-адреса для перегляду аукціону
          x-legalNameEn: Auction link
        description:
          type: object
          allOf:
            - $ref: '#/components/schemas/base.MultiLang'
          x-legalNameUa: Опис аукціону
          x-legalNameEn: Auction description
        accessDetails:
          type: object
          allOf:
            - $ref: '#/components/schemas/base.MultiLang'
          x-legalNameUa: Порядок та можливий час ознайомлення з лотом
          x-legalNameEn: Auction access details
        discount:
          description: 'Якщо tenderAttempts = 1, то поле discount не використовується. Якщо tenderAttempts >1 поле discount використовується, але є не обов''язкове'
          type: object
          allOf:
            - $ref: '#/components/schemas/base.Discount'
          x-legalNameUa: Знижки
          x-legalNameEn: Discount  
        value:
          type: object
          allOf:
            - $ref: '#/components/schemas/base.Value'
          x-legalNameUa: Стартова ціна 
          x-legalNameEn: Start price 
        minNumberOfQualifiedBids:
          description: 'за замовчуванням 2, але повина прийматися ручна правка на 1, без присвоєння статусу аукціону unsuccessful'
          type: integer
          format: int64
          default: 2 # в подальшому можлива зміна на 1
          readOnly: true
          x-legalNameUa: Мінімальна кількість заяв
          x-legalNameEn: Minimal number of bids
        items:
          type: array
          items:
            type: object
            allOf:
              - $ref: '#/components/schemas/base.Items'
          x-legalNameUa: Склад лота
          x-legalNameEn: Lot composition  
        documents:
          type: array
          items:
            type: object
            allOf:
              - $ref: '#/components/schemas/base.Document'
            properties:
              documentOf:
                type: string
                enum:
                  - auction
                  - cancellation
          x-legalNameUa: Всі документи аукціону та пов'язані додатки
          x-legalNameEn: Documents
        bids:
          type: array
          items:
            type: object
            allOf:
              - $ref: '#/components/schemas/base.Bid'
          x-legalNameUa: Заява на участь
          x-legalNameEn:  Bid
        questions:
          type: array
          items:
            type: object
            allOf:
              - $ref: '#/components/schemas/base.Question'
          x-legalNameUa: Сервіс обговорення аукціону (запитання-відповідь)
          x-legalNameEn: Q&A
        awards:
          type: array
          items:
            type: object
            allOf:
              - $ref: '#/components/schemas/base.Award'
          readOnly: true
          x-legalNameUa: Рішення щодо кваліфікації учасників
          x-legalNameEn: Award
        timer:
          type: string
          format: date-time
          readOnly: true
        archiveId:
          type: string
          readOnly: true
        status:
          type: string
          readOnly: true
          x-legalNameUa: Статус процедури
          x-legalNameEn: Procedure status
        cancellations:
          type: array
          items:
            type: object
            allOf:
              - $ref: '#/components/schemas/base.Cancellation'
          readOnly: true
          x-legalNameUa: Скасування Аукціону
          x-legalNameEn: Auction Cancellation
      required: 
        - auctionId
        - procurementMethod
        - procuringEntity
        - tenderAttempts
        - lotId
        - title
        - description
        - value
        - minNumberOfQualifiedBids
        - items
Edited by Denys Barabash