NationGraph FOIA API

The FOIA API from NationGraph — 1 operation(s) for foia.

OpenAPI Specification

nationgraph-foia-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Nationgraph Accounts FOIA API
  version: 0.2.36
tags:
- name: FOIA
paths:
  /api/v3/foia/contract_parser:
    post:
      tags:
      - FOIA
      summary: Enqueue Contract Parser
      operationId: enqueue_contract_parser_api_v3_foia_contract_parser_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FoiaWorkerEnqueueRequest'
        required: true
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FoiaWorkerEnqueueResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    FoiaWorkerEnqueueResponsePayload:
      properties:
        file_path:
          type: string
          title: File Path
        reference_codes:
          items:
            type: string
          type: array
          title: Reference Codes
      type: object
      required:
      - file_path
      - reference_codes
      title: FoiaWorkerEnqueueResponsePayload
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    FoiaWorkerEnqueueResponse:
      properties:
        accepted:
          type: boolean
          title: Accepted
        stream:
          type: string
          title: Stream
        message_id:
          type: string
          title: Message Id
        payload:
          $ref: '#/components/schemas/FoiaWorkerEnqueueResponsePayload'
      type: object
      required:
      - accepted
      - stream
      - message_id
      - payload
      title: FoiaWorkerEnqueueResponse
    FoiaWorkerEnqueueRequest:
      properties:
        file_path:
          type: string
          title: File Path
        reference_codes:
          items:
            type: string
          type: array
          minItems: 1
          title: Reference Codes
      type: object
      required:
      - file_path
      - reference_codes
      title: FoiaWorkerEnqueueRequest
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer