NationGraph Views API

openapi: 3.1.0
info:
  title: Nationgraph Accounts Views API
  version: 0.2.36
tags:
- name: Views
paths:
  /api/v3/views:
    get:
      tags:
      - Views
      summary: List Views
      description: List the authenticated user's saved views, optionally scoped by type/resource.
      operationId: list_views_api_v3_views_get
      security:
      - HTTPBearer: []
      parameters:
      - name: view_type
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ViewType'
          - type: 'null'
          title: View Type
      - name: resource_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Resource Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ViewResponse'
                title: Response List Views Api V3 Views Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Views
      summary: Create View
      description: Create a saved view for the authenticated user.
      operationId: create_view_api_v3_views_post
      security:
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ViewCreateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ViewResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v3/views/{view_id}:
    get:
      tags:
      - Views
      summary: Get View
      description: Get a single saved view by id.
      operationId: get_view_api_v3_views__view_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: view_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: View Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ViewResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Views
      summary: Update View
      description: Update a saved view's name and/or filters.
      operationId: update_view_api_v3_views__view_id__patch
      security:
      - HTTPBearer: []
      parameters:
      - name: view_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: View Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ViewUpdateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ViewResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Views
      summary: Delete View
      description: Delete a saved view.
      operationId: delete_view_api_v3_views__view_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: view_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: View Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    ViewUpdateRequest:
      properties:
        name:
          anyOf:
          - type: string
            maxLength: 255
            minLength: 1
          - type: 'null'
          title: Name
        filters:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Filters
      type: object
      title: ViewUpdateRequest
    ViewResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        owner_id:
          type: string
          title: Owner Id
        view_type:
          $ref: '#/components/schemas/ViewType'
        resource_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Resource Id
        name:
          type: string
          title: Name
        filters:
          additionalProperties: true
          type: object
          title: Filters
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
      - id
      - owner_id
      - view_type
      - resource_id
      - name
      - filters
      - created_at
      - updated_at
      title: ViewResponse
    ViewCreateRequest:
      properties:
        view_type:
          $ref: '#/components/schemas/ViewType'
        resource_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Resource Id
        name:
          type: string
          maxLength: 255
          minLength: 1
          title: Name
        filters:
          additionalProperties: true
          type: object
          title: Filters
      type: object
      required:
      - view_type
      - name
      title: ViewCreateRequest
    ViewType:
      type: string
      enum:
      - accounts
      - rfp_search
      - grant_search
      - automation_results
      title: ViewType
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer