openapi: 3.0.0
info:
  title: Validator API
  version: 0.0.1
tags:
  - name: validator
servers:
  - url: https://example.com/api/validator
paths:
  /v0/scan-proxy/dso-party-id:
    get:
      tags: [ scan-proxy ]
      x-jvm-package: scanproxy
      operationId: "getDsoPartyId"
      responses:
        "200":
          description: ok
          content:
            application/json:
              schema:
                "$ref": "../../../../scan/src/main/openapi/scan.yaml#/components/schemas/GetDsoPartyIdResponse"
  /v0/scan-proxy/dso:
    get:
      tags: [ scan-proxy ]
      x-jvm-package: scanproxy
      operationId: "getDsoInfo"
      responses:
        "200":
          description: ok
          content:
            application/json:
              schema:
                "$ref": "../../../../common/src/main/openapi/common-internal.yaml#/components/schemas/GetDsoInfoResponse"
  /v0/scan-proxy/featured-apps/{provider_party_id}:
    get:
      tags: [ scan-proxy ]
      x-jvm-package: scanproxy
      operationId: "lookupFeaturedAppRight"
      parameters:
        - name: "provider_party_id"
          in: "path"
          required: true
          schema:
            type: string
      responses:
        "200":
          description: ok
          content:
            application/json:
              schema:
                "$ref": "../../../../scan/src/main/openapi/scan.yaml#/components/schemas/LookupFeaturedAppRightResponse"
  /v0/scan-proxy/open-and-issuing-mining-rounds:
    get:
      tags: [ scan-proxy ]
      x-jvm-package: scanproxy
      operationId: "getOpenAndIssuingMiningRounds"
      responses:
        "200":
          description: ok
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/GetOpenAndIssuingMiningRoundsProxyResponse"
  /v0/scan-proxy/amulet-rules:
    get:
      tags: [ scan-proxy ]
      x-jvm-package: scanproxy
      operationId: "getAmuletRules"
      responses:
        "200":
          description: ok
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/GetAmuletRulesProxyResponse"
  /v0/scan-proxy/ans-entries/by-party/{party}:
    get:
      tags: [ scan-proxy ]
      x-jvm-package: scanproxy
      operationId: "lookupAnsEntryByParty"
      parameters:
        - name: "party"
          in: "path"
          required: true
          schema:
            type: string
      responses:
        "200":
          description: ok
          content:
            application/json:
              schema:
                "$ref": "../../../../scan/src/main/openapi/scan.yaml#/components/schemas/LookupEntryByPartyResponse"
        "404":
          $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/404"
  /v0/scan-proxy/ans-entries:
    get:
      tags: [ scan-proxy ]
      x-jvm-package: scanproxy
      operationId: "listAnsEntries"
      parameters:
        - name: "name_prefix"
          in: "query"
          schema:
            type: string
        - name: "page_size"
          in: "query"
          required: true
          schema:
            type: integer
            format: int32
      responses:
        "200":
          description: ok
          content:
            application/json:
              schema:
                "$ref": "../../../../scan/src/main/openapi/scan.yaml#/components/schemas/ListEntriesResponse"
  /v0/scan-proxy/ans-entries/by-name/{name}:
    get:
      tags: [ scan-proxy ]
      x-jvm-package: scanproxy
      operationId: "lookupAnsEntryByName"
      parameters:
        - name: "name"
          in: "path"
          required: true
          schema:
            type: string
      responses:
        "200":
          description: ok
          content:
            application/json:
              schema:
                "$ref": "../../../../scan/src/main/openapi/scan.yaml#/components/schemas/LookupEntryByNameResponse"
        "404":
          $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/404"
  /v0/scan-proxy/ans-rules:
    post:
      tags: [scan-proxy]
      x-jvm-package: scanproxy
      operationId: "getAnsRules"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              "$ref": "../../../../scan/src/main/openapi/scan.yaml#/components/schemas/GetAnsRulesRequest"
      responses:
        "200":
          description: ok
          content:
            application/json:
              schema:
                "$ref": "../../../../scan/src/main/openapi/scan.yaml#/components/schemas/GetAnsRulesResponse"
  /v0/scan-proxy/transfer-preapprovals/by-party/{party}:
    get:
      tags: [scan-proxy]
      x-jvm-package: scanproxy
      operationId: "lookupTransferPreapprovalByParty"
      parameters:
        - name: "party"
          in: "path"
          required: true
          schema:
            type: string
      responses:
        "200":
          description: ok
          content:
            application/json:
              schema:
                "$ref": "../../../../scan/src/main/openapi/scan.yaml#/components/schemas/LookupTransferPreapprovalByPartyResponse"
        "404":
          $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/404"
  /v0/scan-proxy/transfer-command-counter/{party}:
    get:
      tags: [scan-proxy]
      x-jvm-package: scanproxy
      operationId: "lookupTransferCommandCounterByParty"
      parameters:
        - name: "party"
          in: "path"
          required: true
          schema:
            type: string
      responses:
        "200":
          description: ok
          content:
            application/json:
              schema:
                "$ref": "../../../../scan/src/main/openapi/scan.yaml#/components/schemas/LookupTransferCommandCounterByPartyResponse"
        "404":
          description: No TransferCommandCounter exists for this party. This means the nonce that should be used is 0.
          $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/404"
  /v0/scan-proxy/transfer-command/status:
    get:
      description: Retrieve the status of all transfer commands of the given sender for the specified nonce.
      tags: [scan-proxy]
      x-jvm-package: scanproxy
      operationId: "lookupTransferCommandStatus"
      parameters:
        - name: sender
          in: query
          required: true
          schema:
            type: string
        - name: nonce
          in: query
          required: true
          schema:
            type: integer
            format: int64
      responses:
        "200":
          description: ok
          content:
            application/json:
              schema:
                "$ref": "../../../../scan/src/main/openapi/scan.yaml#/components/schemas/LookupTransferCommandStatusResponse"
        "404":
          description: No TransferCommand exists with this contract id within the last 24h
          $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/404"
  /v0/scan-proxy/holdings/summary:
    post:
      deprecated: true
      tags: [ deprecated ]
      x-jvm-package: scanproxy
      operationId: "getHoldingsSummaryAt"
      description: |
        Deprecated. Please use /v1/scan-proxy/holdings/summary instead. Returns the summary of active amulet contracts for a given migration id and record time, for the given parties.
        This is an aggregate of `/v0/holdings/state` by owner party ID with better performance than client-side computation.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "../../../../scan/src/main/openapi/scan.yaml#/components/schemas/HoldingsSummaryRequest"
      responses:
        "200":
          description: ok
          content:
            application/json:
              schema:
                $ref: "../../../../scan/src/main/openapi/scan.yaml#/components/schemas/HoldingsSummaryResponse"
        "400":
          $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/400"
        "404":
          $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/404"
        "500":
          $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/500"
  /v1/scan-proxy/holdings/summary:
    post:
      tags: [ scan-proxy ]
      x-jvm-package: scanproxy
      operationId: "getHoldingsSummaryAtV1"
      description: |
        Returns the summary of active amulet contracts for a given migration id and record time, for the given parties.
        This is an aggregate of `/v0/holdings/state` by owner party ID with better performance than client-side computation.
        Unlike /v0/scan-proxy/holdings/summary, this version does not include holding fee fields
        as they do not express a meaningful aggregate value.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "../../../../scan/src/main/openapi/scan.yaml#/components/schemas/HoldingsSummaryRequestV1"
      responses:
        "200":
          description: ok
          content:
            application/json:
              schema:
                $ref: "../../../../scan/src/main/openapi/scan.yaml#/components/schemas/HoldingsSummaryResponseV1"
        "400":
          $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/400"
        "404":
          $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/404"
        "500":
          $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/500"
  /v0/scan-proxy/unclaimed-development-fund-coupons:
    get:
      tags: [ scan-proxy ]
      x-jvm-package: scanproxy
      operationId: "listUnclaimedDevelopmentFundCoupons"
      description: |
        List all unclaimed development fund coupons.
      responses:
        "200":
          description: ok
          content:
            application/json:
              schema:
                "$ref": "../../../../scan/src/main/openapi/scan.yaml#/components/schemas/ListUnclaimedDevelopmentFundCouponsResponse"
components:
  schemas:
    # does not include the TTL, and the contracts are not-MaybeCached
    GetOpenAndIssuingMiningRoundsProxyResponse:
      type: object
      required:
        [
          "open_mining_rounds",
          "issuing_mining_rounds",
        ]
      properties:
        open_mining_rounds:
          type: array
          items:
            $ref: "../../../../common/src/main/openapi/common-internal.yaml#/components/schemas/ContractWithState"
        issuing_mining_rounds:
          type: array
          items:
            $ref: "../../../../common/src/main/openapi/common-internal.yaml#/components/schemas/ContractWithState"
    # the contract is not-MaybeCached
    GetAmuletRulesProxyResponse:
      type: object
      required:
        [
          "amulet_rules",
        ]
      properties:
        amulet_rules:
          "$ref": "../../../../common/src/main/openapi/common-internal.yaml#/components/schemas/ContractWithState"