CubeNexus Inc Wellbore API

openapi: 3.2.0
info:
  title: Fast Wellbore API
  version: 0.1.0
tags:
- name: Wellbore
paths:
  /wellbore/trajectory:
    get:
      summary: Load Wellbore Trajectory
      description: 'Serve validated wellbore trajectories as 3D polylines.


        Takes `bbox` or `wellbore_ids`, never both. The table, schema and catalog are

        fixed module constants -- this route serves one table and takes no identifier

        from the caller.


        ONLY `validation_status = ''PASS''` IS SERVABLE. A trajectory that failed its

        closure or gap check is filtered out in SQL, not styled differently and not

        flagged to the client. A wellbore that failed validation is one whose shape

        is not known to be right, and a wrong trajectory drawn faintly is still a

        wrong trajectory on the map.


        NO UNIT OR DATUM CONVERSION HAPPENS HERE. `elevation_m_ellipsoid` is read and

        passed through untouched. The conversion from orthometric to ellipsoidal

        height needs the geoid undulation and the datum transform, both of which are

        already applied upstream when the row is written; redoing any part of it in

        the serving path is how a second, divergent definition of "elevation" gets

        created.'
      operationId: load_wellbore_trajectory_wellbore_trajectory_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: bbox
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: minLng,minLat,maxLng,maxLat in WGS84
          title: Bbox
        description: minLng,minLat,maxLng,maxLat in WGS84
      - name: wellbore_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: comma-separated wellbore_id list
          title: Wellbore Ids
        description: comma-separated wellbore_id list
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Wellbore
  /wellbore/ingest:
    post:
      summary: Wellbore Ingest
      description: 'Fetch, extract and validate one well''s directional survey on demand.


        READY without starting anything when the table already serves the well --

        the expensive path is not the default, and a user clicking a well that is

        already loaded must not spend a serverless start to learn that.


        Otherwise STARTED with a run id to poll. The job is fire-and-forget exactly

        as `lidar_ingest` is: `run_now` returns as soon as the run is queued, and

        waiting on `.result()` here would hold an HTTP worker for minutes.'
      operationId: wellbore_ingest_wellbore_ingest_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WellboreIngestRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer: []
      tags:
      - Wellbore
  /wellbore/ingest/{run_id}:
    get:
      summary: Wellbore Ingest Status
      description: 'Poll one ingest run, and say what the caller can actually draw.


        The Databricks run state alone is not the answer. A run that SUCCEEDS may

        still have promoted nothing -- the well may have no survey on file, or

        every leg may have been flagged -- and all three of those are "job

        finished, result_state SUCCESS". So the terminal status comes from the

        job''s own per-document state table, and the run state only decides whether

        it is worth reading yet.'
      operationId: wellbore_ingest_status_wellbore_ingest__run_id__get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: run_id
        in: path
        required: true
        schema:
          type: integer
          title: Run Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Wellbore
  /wellbore/summary:
    get:
      summary: Wellbore Summary
      operationId: wellbore_summary_wellbore_summary_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: q
        in: query
        required: false
        schema:
          type: string
          maxLength: 120
          default: ''
          title: Q
      - name: state
        in: query
        required: false
        schema:
          type: string
          default: OK
          title: State
      - name: county
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: County
      - name: operator
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: Operator
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: Status
      - name: township
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 12
          - type: 'null'
          title: Township
      - name: range
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 12
          - type: 'null'
          title: Range
      - name: section
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 36
            minimum: 1
          - type: 'null'
          title: Section
      - name: survey
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 20
          - type: 'null'
          title: Survey
      - name: documents
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Documents
      - name: include_feed
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Include Feed
      - name: geographic_scope_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Geographic Scope Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Wellbore
  /wellbore/export:
    get:
      summary: Wellbore Export
      operationId: wellbore_export_wellbore_export_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: q
        in: query
        required: false
        schema:
          type: string
          maxLength: 120
          default: ''
          title: Q
      - name: state
        in: query
        required: false
        schema:
          type: string
          default: OK
          title: State
      - name: county
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: County
      - name: operator
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: Operator
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: Status
      - name: township
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 12
          - type: 'null'
          title: Township
      - name: range
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 12
          - type: 'null'
          title: Range
      - name: section
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 36
            minimum: 1
          - type: 'null'
          title: Section
      - name: survey
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 20
          - type: 'null'
          title: Survey
      - name: documents
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Documents
      - name: include_feed
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Include Feed
      - name: bbox
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Bbox
      - name: geographic_scope_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Geographic Scope Id
      - name: source_revision
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            minLength: 64
            maxLength: 64
          - type: 'null'
          title: Source Revision
      - name: query_fingerprint
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            minLength: 24
            maxLength: 24
          - type: 'null'
          title: Query Fingerprint
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Wellbore
  /wellbore/search:
    get:
      summary: Wellbore Search
      operationId: wellbore_search_wellbore_search_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: q
        in: query
        required: false
        schema:
          type: string
          maxLength: 120
          default: ''
          title: Q
      - name: state
        in: query
        required: false
        schema:
          type: string
          default: OK
          title: State
      - name: county
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: County
      - name: operator
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: Operator
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: Status
      - name: township
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 12
          - type: 'null'
          title: Township
      - name: range
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 12
          - type: 'null'
          title: Range
      - name: section
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 36
            minimum: 1
          - type: 'null'
          title: Section
      - name: survey
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 20
          - type: 'null'
          title: Survey
      - name: documents
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Documents
      - name: include_feed
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Include Feed
      - name: bbox
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Bbox
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 50
          title: Limit
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 2000
          - type: 'null'
          title: Cursor
      - name: geographic_scope_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            minLength: 1
            maxLength: 200
          - type: 'null'
          title: Geographic Scope Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Wellbore
  /wellbore/map/v2:
    get:
      summary: Wellbore Map Points
      operationId: wellbore_map_points_wellbore_map_v2_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: q
        in: query
        required: false
        schema:
          type: string
          maxLength: 120
          default: ''
          title: Q
      - name: state
        in: query
        required: false
        schema:
          type: string
          default: OK
          title: State
      - name: county
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 100
          - type: 'null'
          title: County
      - name: operator
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: Operator
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 40
          - type: 'null'
          title: Status
      - name: township
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 12
          - type: 'null'
          title: Township
      - name: range
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 12
          - type: 'null'
          title: Range
      - name: section
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 36
            minimum: 1
          - type: 'null'
          title: Section
      - name: survey
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 20
          - type: 'null'
          title: Survey
      - name: documents
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Documents
      - name: include_feed
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Include Feed
      - name: bbox
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Bbox
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 5000
          minimum: 1
          default: 2000
          title: Limit
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 4000
          - type: 'null'
          title: Cursor
      - name: geographic_scope_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            minLength: 1
            maxLength: 200
          - type: 'null'
          title: Geographic Scope Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Wellbore
  /wellbore/map:
    get:
      summary: Wellbore Map
      description: Bounded map representation of every match, independent of list paging.
      operationId: wellbore_map_wellbore_map_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: q
        in: query
        required: false
        schema:
          type: string
          maxLength: 120
          default: ''
          title: Q
      - name: state
        in: query
        required: false
        schema:
          type: string
          default: OK
          title: State
      - name: county
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: County
      - name: operator
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: Operator
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: Status
      - name: township
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 12
          - type: 'null'
          title: Township
      - name: range
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 12
          - type: 'null'
          title: Range
      - name: section
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 36
            minimum: 1
          - type: 'null'
          title: Section
      - name: survey
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 20
          - type: 'null'
          title: Survey
      - name: documents
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Documents
      - name: include_feed
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Include Feed
      - name: bbox
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Bbox
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          default: 1000
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Wellbore
  /wellbore/{api_10}/attributes:
    get:
      summary: Well Attributes Result
      operationId: well_attributes_result_wellbore__api_10__attributes_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: api_10
        in: path
        required: true
        schema:
          type: string
          title: Api 10
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          default: 200
          title: Limit
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            minLength: 1
            maxLength: 1024
          - type: 'null'
          title: Cursor
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Wellbore
  /wellbore/{api_10}/survey-candidates:
    get:
      summary: Wellbore Survey Candidates
      description: Explicit staging source; immutable originals and production tables stay intact.
      operationId: wellbore_survey_candidates_wellbore__api_10__survey_candidates_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: api_10
        in: path
        required: true
        schema:
          type: string
          title: Api 10
      - name: include_plans
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Include Plans
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Wellbore
  /wellbore/{api_10}/feed-paths:
    get:
      summary: Wellbore Feed Paths
      operationId: wellbore_feed_paths_wellbore__api_10__feed_paths_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: api_10
        in: path
        required: true
        schema:
          type: string
          title: Api 10
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Wellbore
  /wellbore/{api_10}/formation-observations:
    get:
      summary: Wellbore Formation Observations
      operationId: wellbore_formation_observations_wellbore__api_10__formation_observations_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: api_10
        in: path
        required: true
        schema:
          type: string
          title: Api 10
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Wellbore
  /wellbore/{api_10}/documents:
    get:
      summary: Wellbore Documents
      operationId: wellbore_documents_wellbore__api_10__documents_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: api_10
        in: path
        required: true
        schema:
          type: string
          title: Api 10
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Wellbore
  /wellbore/documents/{document_id}/content:
    get:
      summary: Wellbore Document Content
      operationId: wellbore_document_content_wellbore_documents__document_id__content_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document Id
      - name: download
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Download
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Wellbore
  /wellbore/documents/{document_id}/pages:
    get:
      summary: Wellbore Document Pages
      operationId: wellbore_document_pages_wellbore_documents__document_id__pages_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document Id
      - name: page
        in: query
        required: false
        schema:
          type: integer
          maximum: 10000
          minimum: 1
          default: 1
          title: Page
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Wellbore
  /wellbore/resolve:
    get:
      summary: Wellbore Resolve
      description: 'Resolve a free-text well reference to candidate wells.


        The function is a module constant and takes no catalog from the caller,

        like every other route on this table.


        IT RETURNS NO COORDINATES, and that is deliberate rather than an omission:

        the agent contract is coordinate-free, and this route feeds the same

        picker the agent''s answers flow into. Everything spatial is resolved

        server-side from the API-10.'
      operationId: wellbore_resolve_wellbore_resolve_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
          minLength: 2
          maxLength: 120
          description: well name, partial name, or API
          title: Q
        description: well name, partial name, or API
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Wellbore
components:
  schemas:
    WellboreIngestRequest:
      properties:
        api_10:
          type: string
          maxLength: 10
          minLength: 10
          title: Api 10
      type: object
      required:
      - api_10
      title: WellboreIngestRequest
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: login