CIP — Catchment Index Processing Service

openapi: 3.1.0
info:
  title: CIP-service Indexing API
  description: CIP-service is a project of the US Environmental Protection Agency Office of Water providing containers, logic and data for the task of associating or _indexing_ hydrologic features with NHDPlus features at multiple resolutions.  CIP-service supports a variety of purposes indexing to catchments, reaches or navigating the NHDPlus network for discovery or flow analysis. The majority of logic occurs within a containerized PostgreSQL database with additional containers providing support products such as an API, Jupyter Notebooks and sample demo applications. All components of the provided container stack are open source.
  termsOfService: https://www.epa.gov/web-policies-and-procedures/epa-disclaimers#geospatial
  contact:
    name: US EPA Office of Water
    url: https://www.epa.gov/aboutepa/about-office-water
  license:
    name: Creative Commons Zero v1.0 Universal
    identifier: CC0-1.0
  version: 1.5.2
servers:
  - url: https://localhost:3000
    description: Change this endpoint as needed to your CIP-server PostgREST container
paths:
  /rpc/cipsrv_index:
    post:
      tags:
        - 'CIP Indexing Services'
      summary: CIP-service Indexing
      description: CIP-service Indexing Endpoint
      operationId: cipsrv_index
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cipsrv_index_rb'
            examples:
              cipsrv_indexRequestExample:
                summary: Default cipsrv_index request
                x-microcks-default: true
                value: {}
      responses:
        '200':
          description: CIP-service Indexing Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cipsrv_index_resp'
              examples:
                cipsrv_index200Example:
                  summary: Default cipsrv_index 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rpc/cipsrv_domains:
    get:
      tags:
        - 'CIP Indexing Services'
      summary: CIP-service Domains
      description: CIP-service Domains Endpoint
      operationId: cipsrv_domains
      responses:
        '200':
          description: states and tribes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cipsrv_domains'
              examples:
                cipsrv_domains200Example:
                  summary: Default cipsrv_domains 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rpc/cipsrv_registry:
    get:
      tags:
        - 'CIP Indexing Services'
      summary: CIP-service Registry Summary of Resources
      description: CIP-service Registry showing components and relative vintage of datasets.
      operationId: cipsrv_registry
      responses:
        '200':
          description: summary of resources
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cipsrv_registry'
              examples:
                cipsrv_registry200Example:
                  summary: Default cipsrv_registry 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rpc/navigate:
    post:
      tags:
        - 'Analysis Services'
      summary: CIP-service Navigation
      description: CIP-service Navigation Endpoint
      operationId: navigate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/navigate_rb'
            examples:
              navigateRequestExample:
                summary: Default navigate request
                x-microcks-default: true
                value: {}
      responses:
        '200':
          description: CIP-service Navigation Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/navigate_resp'
              examples:
                navigate200Example:
                  summary: Default navigate 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rpc/delineate:
    post:
      tags:
        - 'Analysis Services'
      summary: CIP-service Delineation
      description: CIP-service Delineation Endpoint
      operationId: delineate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/delineate_rb'
            examples:
              delineateRequestExample:
                summary: Default delineate request
                x-microcks-default: true
                value: {}
      responses:
        '200':
          description: CIP-service Delineation Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/delineate_resp'
              examples:
                delineate200Example:
                  summary: Default delineate 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rpc/pointindexing:
    post:
      tags:
        - 'Analysis Services'
      summary: CIP-service Point Indexing
      description: CIP-service Point Indexing Endpoint
      operationId: pointindexing
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pointindexing_rb'
            examples:
              pointindexingRequestExample:
                summary: Default pointindexing request
                x-microcks-default: true
                value: {}
      responses:
        '200':
          description: CIP-service Point Indexing Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pointindexing_resp'
              examples:
                pointindexing200Example:
                  summary: Default pointindexing 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rpc/upstreamdownstream:
    post:
      tags:
        - 'Analysis Services'
      summary: CIP-service Upstream Downstream
      description: CIP-service Upstream Downstream Endpoint
      operationId: upstreamdownstream
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/upstreamdownstream_rb'
            examples:
              upstreamdownstreamRequestExample:
                summary: Default upstreamdownstream request
                x-microcks-default: true
                value: {}
      responses:
        '200':
          description: CIP-service Upstream Downstream Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/upstreamdownstream_resp'
              examples:
                upstreamdownstream200Example:
                  summary: Default upstreamdownstream 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rpc/flow_accumulation:
    post:
      tags:
        - 'Analysis Services'
      summary: CIP-service Flow Accumulation
      description: CIP-service Flow Accumulation
      operationId: flow_accumulation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/flow_accumulation_rb'
            examples:
              flow_accumulationRequestExample:
                summary: Default flow_accumulation request
                x-microcks-default: true
                value: {}
      responses:
        '200':
          description: CIP-service Flow Accumulation Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/flow_accumulation_resp'
              examples:
                flow_accumulation200Example:
                  summary: Default flow_accumulation 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rpc/randomcatchment:
    post:
      tags:
        - 'Utility Services'
      summary: CIP-service Utility Random Catchment
      description: CIP-service Utility Random Catchment Endpoint
      operationId: randomcatchment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/randomcatchment_rb'
            examples:
              randomcatchmentRequestExample:
                summary: Default randomcatchment request
                x-microcks-default: true
                value: {}
      responses:
        '200':
          description: CIP-service Utility Random Catchment Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/randomcatchment_resp'
              examples:
                randomcatchment200Example:
                  summary: Default randomcatchment 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rpc/randomhuc12:
    post:
      tags:
        - 'Utility Services'
      summary: CIP-service Utility Random HUC12
      description: CIP-service Utility Random HUC12 Endpoint
      operationId: randomhuc12
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/randomhuc12_rb'
            examples:
              randomhuc12RequestExample:
                summary: Default randomhuc12 request
                x-microcks-default: true
                value: {}
      responses:
        '200':
          description: CIP-service Utility Random HUC12 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/randomhuc12_resp'
              examples:
                randomhuc12200Example:
                  summary: Default randomhuc12 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rpc/randomnav:
    post:
      tags:
        - 'Utility Services'
      summary: CIP-service Utility Random Nav Location
      description: CIP-service Utility Random Nav Location Endpoint
      operationId: randomnav
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/randomnav_rb'
            examples:
              randomnavRequestExample:
                summary: Default randomnav request
                x-microcks-default: true
                value: {}
      responses:
        '200':
          description: CIP-service Utility Random Nav Location Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/randomnav_resp'
              examples:
                randomnav200Example:
                  summary: Default randomnav 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rpc/randompoint:
    post:
      tags:
        - 'Utility Services'
      summary: CIP-service Utility Random Point
      description: CIP-service Utility Random Point Endpoint
      operationId: randompoint
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/randompoint_rb'
            examples:
              randompointRequestExample:
                summary: Default randompoint request
                x-microcks-default: true
                value: {}
      responses:
        '200':
          description: CIP-service Utility Random Point Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/randompoint_resp'
              examples:
                randompoint200Example:
                  summary: Default randompoint 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rpc/randomppnav:
    post:
      tags:
        - 'Utility Services'
      summary: CIP-service Utility Random PP Nav Locations
      description: CIP-service Utility Random PP Nav Locations Endpoint
      operationId: randomppnav
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/randomppnav_rb'
            examples:
              randomppnavRequestExample:
                summary: Default randomppnav request
                x-microcks-default: true
                value: {}
      responses:
        '200':
          description: CIP-service Utility Random PP Nav Locations Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/randomppnav_resp'
              examples:
                randomppnav200Example:
                  summary: Default randomppnav 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    cipsrv_index_rb:
      type: object
      properties:
        points:
          description: GeoJSON feature or feature collection of one or more points to index.
          oneOf:
            - $ref: '#/components/schemas/geojson_featurecollection'
            - $ref: '#/components/schemas/geojson_feature'
            - type: 'null'
          example: string
        lines:
          description: GeoJSON feature or feature collection of one or more line strings to index.
          oneOf:
            - $ref: '#/components/schemas/geojson_featurecollection'
            - $ref: '#/components/schemas/geojson_feature'
            - type: 'null'
          example: string
        areas:
          description: GeoJSON feature or feature collection of one or more polygons to index.
          oneOf:
            - $ref: '#/components/schemas/geojson_featurecollection'
            - $ref: '#/components/schemas/geojson_feature'
            - type: 'null'
          example: string
        geometry:
          description: GeoJSON geometry, feature or feature collection of one or more geometries to index.
          oneOf:
            - $ref: '#/components/schemas/geojson_featurecollection'
            - $ref: '#/components/schemas/geojson_feature'
            - $ref: '#/components/schemas/geojson_geometry'
            - type: 'null'
          example: string
        geometry_clip:
          description: array of clip items to apply to the incoming features.
          type: ['array', 'null']
          items:
            type: 'string'
          example: string
        geometry_clip_stage:
          description: flag to control whether to clip features before or after indexing.
          type: ['string', 'null']
          enum:
            - BEFORE
            - AFTER
          default: BEFORE
          example: BEFORE
        catchment_filter:
          description: >
            Array of filter items to apply to indexing results.  Filter values may include:
               * USPS codes for the 50 states plus DC, PR, VI, AS, GU and MP.
               * Tribal keywords: ALLTRIBAL, PARTTRIBAL, NOTRIBAL or TRIBAL < X.
            For the TRIBAL < X keyword X is a decimal percentage that tribal percentage of the catchment must meet to be included.
          type: ['array', 'null']
          items:
            type: string
          example: string
        nhdplus_version:
          default: nhdplus_h
          $ref: '#/components/schemas/nhdplus_version'
        wbd_version:
          default: NP21
          $ref: '#/components/schemas/wbd_version'
        default_point_indexing_method:
          description: Point indexing method to use when point features are received without expressly defining a point indexing method.
          type: ['string', 'null']
          enum:
            - point_simple
          default: point_simple
          example: point_simple
        default_line_indexing_method:
          description: Line indexing method to use when line features are received without expressly defining a line indexing method.
          type: ['string', 'null']
          enum:
            - line_simple
            - line_levelpath
          default: line_simple
          example: line_simple
        default_line_threshold:
          description: Linear threshold percentage (0 - 100) to use when linear features are received without expressly defining a linear threshold value.
          type: ['number', 'null']
          minimum: 0
          maximum: 100
          example: string
        default_ring_indexing_method:
          description: Area indexing method to use when linear features that form a closed ring are received without expressly defining a ring indexing method.  To preclude ring processing, set this value to **treat_as_lines**.
          type: ['string', 'null']
          enum:
            - area_simple
            - area_centroid
            - area_artpath
            - treat_as_lines
          default: treat_as_lines
          example: area_simple
        default_ring_areacat_threshold:
          description: Area catchment threshold percentage (0 - 100) to use when ring features are received without expressly defining a ring area catchment threshold value.
          type: ['number', 'null']
          minimum: 0
          maximum: 100
          example: string
        default_ring_areaevt_threshold:
          description: Area event threshold percentage (0 - 100) to use when ring features are received without expressly defining a ring area event threshold value.
          type: ['number', 'null']
          minimum: 0
          maximum: 100
          example: string
        default_area_indexing_method:
          description: Area indexing method to use when polygon features are received without expressly defining an area indexing method.
          type: ['string', 'null']
          enum:
            - area_simple
            - area_centroid
            - area_artpath
          default: area_simple
          example: area_simple
        default_areacat_threshold:
          description: Area catchment threshold percentage (0 - 100) to use when area features are received without expressly defining an area catchment threshold value.
          type: ['number', 'null']
          minimum: 0
          maximum: 100
          example: string
        default_areaevt_threshold:
          description: Area event threshold percentage (0 - 100) to use when area features are received without expressly defining an area event threshold value.
          type: ['number', 'null']
          minimum: 0
          maximum: 100
          example: string
        known_region:
          oneOf:
            - $ref: '#/components/schemas/known_region'
            - type: 'null'
          example: string
        return_indexing_summary:
          description: Flag as to whether to return a detailed summary of the indexing actions.  Setting this false will slightly improve performance and throughput.
          type: ['boolean', 'null']
          default: true
          example: string
        return_indexed_features:
          description: >
            Flag as to whether to return indexed features in the results payload.
            Indexing may clip features creating a smaller, different geometry that users may wish to inspect.
            Setting this false will improve performance when large features are clipped to detailed political borders.
          type: ['boolean', 'null']
          default: true
          example: string
        return_indexed_collection:
          description: >
            Flag as to whether to return all indexed features as a single geometry collection.
            This functionality is meant for users who just wish all the features back in a simple format for easy display purposes.
          type: ['boolean', 'null']
          default: false
          example: string
        return_catchment_geometry:
          description: Flag as to whether to return the catchment geometry in the results payload.
          type: ['boolean', 'null']
          default: true
          example: string
        return_flowlines:
          description: Flag as to whether to return a feature collection of flowlines associated with indexed catchments.
          type: ['boolean', 'null']
          default: true
          example: string
        return_huc12s:
          description: Flag as to whether to return a feature collection of HUC12s associated with indexed catchments.
          type: ['boolean', 'null']
          default: false
          example: string
        return_flowline_geometry:
          description: Flag as to return the flowline geometry when flowlines are returned in the results payload.
          type: ['boolean', 'null']
          default: true
          example: string
        return_huc12_geometry:
          description: Flag as to return the HUC12 geometry when HUC12s are returned in the results payload.  Currently non-functional.
          type: ['boolean', 'null']
          default: true
          example: string
        return_full_catchments:
          description: Flag to allow indexing to return full catchments not split by state or national borders.
          type: ['boolean', 'null']
          default: false
          example: string
        limit_to_us_catchments:
          description: Flag to allow indexing to return catchments outside the borders of the United States.
          type: ['boolean', 'null']
          default: true
          example: string
      required:
        - nhdplus_version
    cipsrv_index_resp:
      type: object
      properties:
        indexed_points:
          description: Feature collection of point event features processed through CIP indexing.
          $ref: '#/components/schemas/geojson_featurecollection'
        indexed_lines:
          description: Feature collection of line event features processed through CIP indexing.
          $ref: '#/components/schemas/geojson_featurecollection'
        indexed_areas:
          description: Feature collection of area event features processed through CIP indexing.
          $ref: '#/components/schemas/geojson_featurecollection'
        indexed_collection:
          description: Geometry of all event features processed through CIP indexing.
          $ref: '#/components/schemas/geojson_geometry'
        indexing_summary:
          $ref: '#/components/schemas/indexing_summary'
        catchment_count:
          type: integer
          format: int32
          example: 100
        catchment_areasqkm:
          type: number
          example: 0.0
        nhdplus_version:
          $ref: '#/components/schemas/nhdplus_version'
        catchments:
          $ref: '#/components/schemas/geojson_featurecollection'
        flowlines:
          $ref: '#/components/schemas/geojson_featurecollection'
        huc12s:
          $ref: '#/components/schemas/geojson_featurecollection'
        return_code:
          $ref: '#/components/schemas/return_code'
        status_message:
          $ref: '#/components/schemas/status_message'
    navigate_rb:
      type: object
      properties:
        nhdplus_version:
          default: nhdplus_h
          $ref: '#/components/schemas/nhdplus_version'
        search_type:
          $ref: '#/components/schemas/search_type'
        start_nhdplusid:
          oneOf:
            - $ref: '#/components/schemas/start_nhdplusid'
            - type: 'null'
          example: '12345'
        start_permanent_identifier:
          oneOf:
            - $ref: '#/components/schemas/start_permanent_identifier'
            - type: 'null'
          example: '12345'
        start_reachcode:
          oneOf:
            - $ref: '#/components/schemas/start_reachcode'
            - type: 'null'
          example: string
        start_hydroseq:
          oneOf:
            - $ref: '#/components/schemas/start_hydroseq'
            - type: 'null'
          example: string
        start_measure:
          oneOf:
            - $ref: '#/components/schemas/start_measure'
            - type: 'null'
          example: string
        stop_nhdplusid:
          oneOf:
            - $ref: '#/components/schemas/stop_nhdplusid'
            - type: 'null'
          example: '12345'
        stop_permanent_identifier:
          oneOf:
            - $ref: '#/components/schemas/stop_permanent_identifier'
            - type: 'null'
          example: '12345'
        stop_reachcode:
          oneOf:
            - $ref: '#/components/schemas/stop_reachcode'
            - type: 'null'
          example: string
        stop_hydroseq:
          oneOf:
            - $ref: '#/components/schemas/stop_hydroseq'
            - type: 'null'
          example: string
        stop_measure:
          oneOf:
            - $ref: '#/components/schemas/stop_measure'
            - type: 'null'
          example: string
        max_distancekm:
          oneOf:
            - $ref: '#/components/schemas/max_distancekm'
            - type: 'null'
          example: string
        max_flowtimeday:
          oneOf:
            - $ref: '#/components/schemas/max_flowtimeday'
            - type: 'null'
          example: string
        return_flowline_details:
          oneOf:
            - $ref: '#/components/schemas/return_flowline_details'
            - type: 'null'
          example: string
        return_flowline_geometry:
          oneOf:
            - $ref: '#/components/schemas/return_flowline_geometry'
            - type: 'null'
          example: string
        known_region:
          oneOf:
            - $ref: '#/components/schemas/known_region'
            - type: 'null'
          example: string
    navigate_resp:
      type: object
      properties:
        flowlines:
          $ref: '#/components/schemas/geojson_featurecollection'
        flowline_count:
          $ref: '#/components/schemas/flowline_count'
        nhdplus_version:
          $ref: '#/components/schemas/nhdplus_version'
        return_code:
          $ref: '#/components/schemas/return_code'
        status_message:
          $ref: '#/components/schemas/status_message'
    delineate_rb:
      type: object
      properties:
        nhdplus_version:
          default: nhdplus_h
          $ref: '#/components/schemas/nhdplus_version'
        search_type:
          $ref: '#/components/schemas/search_type'
        start_nhdplusid:
          oneOf:
            - $ref: '#/components/schemas/start_nhdplusid'
            - type: 'null'
          example: '12345'
        start_permanent_identifier:
          oneOf:
            - $ref: '#/components/schemas/start_permanent_identifier'
            - type: 'null'
          example: '12345'
        start_reachcode:
          oneOf:
            - $ref: '#/components/schemas/start_reachcode'
            - type: 'null'
          example: string
        start_hydroseq:
          oneOf:
            - $ref: '#/components/schemas/start_hydroseq'
            - type: 'null'
          example: string
        start_measure:
          oneOf:
            - $ref: '#/components/schemas/start_measure'
            - type: 'null'
          example: string
        stop_nhdplusid:
          oneOf:
            - $ref: '#/components/schemas/stop_nhdplusid'
            - type: 'null'
          example: '12345'
        stop_permanent_identifier:
          oneOf:
            - $ref: '#/components/schemas/stop_permanent_identifier'
            - type: 'null'
          example: '12345'
        stop_reachcode:
          oneOf:
            - $ref: '#/components/schemas/stop_reachcode'
            - type: 'null'
          example: string
        stop_hydroseq:
          oneOf:
            - $ref: '#/components/schemas/stop_hydroseq'
            - type: 'null'
          example: string
        stop_measure:
          oneOf:
            - $ref: '#/components/schemas/stop_measure'
            - type: 'null'
          example: string
        aggregation_engine:
          oneOf:
            - $ref: '#/components/schemas/aggregation_engine'
            - type: 'null'
          example: string
        max_distancekm:
          oneOf:
            - $ref: '#/components/schemas/max_distancekm'
            - type: 'null'
          example: string
        max_flowtimeday:
          oneOf:
            - $ref: '#/components/schemas/max_flowtimeday'
            - type: 'null'
          example: string
        split_initial_catchment:
          oneOf:
            - $ref: '#/components/schemas/split_initial_catchment'
            - type: 'null'
          example: string
        fill_basin_holes:
          oneOf:
            - $ref: '#/components/schemas/fill_basin_holes'
            - type: 'null'
          example: string
        return_delineation_geometry:
          oneOf:
            - $ref: '#/components/schemas/return_delineation_geometry'
            - type: 'null'
          example: string
        return_flowline_details:
          oneOf:
            - $ref: '#/components/schemas/return_flowline_details'
            - type: 'null'
          example: string
        return_flowline_geometry:
          oneOf:
            - $ref: '#/components/schemas/return_flowline_geometry'
            - type: 'null'
          example: string
    delineate_resp:
      type: object
      properties:
        delineated_area:
          obj_type: delineated_area_properties
          $ref: '#/components/schemas/geojson_featurecollection'
        aggregation_used:
          description: aggregation logic used in delineation action.
          type: string
          example: string
        flowlines:
          $ref: '#/components/schemas/geojson_featurecollection'
        flowline_count:
          $ref: '#/components/schemas/flowline_count'
        nhdplus_version:
          $ref: '#/components/schemas/nhdplus_version'
        return_code:
          $ref: '#/components/schemas/return_code'
        status_message:
          $ref: '#/components/schemas/status_message'
    pointindexing_rb:
      type: object
      properties:
        point:
          oneOf:
            - $ref: '#/components/schemas/geojson_featurecollection'
            - $ref: '#/components/schemas/geojson_feature'
            - $ref: '#/components/schemas/geojson_geometry'
          example: string
        indexing_engine:
          oneOf:
            - $ref: '#/components/schemas/indexing_engine'
            - type: 'null'
          example: string
        fcode_allow:
          oneOf:
            - $ref: '#/components/schemas/fcode_allow'
            - type: 'null'
          exam

# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/epa/refs/heads/main/openapi/cip-service-openapi.yml