openapi: 3.2.0
info:
  version: v2.222.1
  title: Corva App Store Template Sections API
  description: 'The Corva API is a powerful interface providing great flexibility and extensibility with Corva. Whether your needs are simple UI visualizations, data entry, replication/sync tasks, real-time stream processing, or complex machine learning CPU-intensive apps, the Corva API is the way to make it happen. Our concepts are split into three distinct silos: data apps, visualization apps, and a REST API'
  termsOfService: https://www.corva.ai/terms-and-conditions/
  contact:
    name: Corva API Team
    email: support@corva.ai
security:
- api_key: []
tags:
- name: AppStoreTemplateSections
paths:
  /v2/app_store_template_sections:
    get:
      summary: List AppStoreTemplateSections
      tags:
      - AppStoreTemplateSections
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          type: object
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppStoreTemplateSectionList'
      parameters:
      - in: query
        name: page
        description: Number of page
        schema:
          type: integer
      - in: query
        name: per_page
        description: Number of items to list per page
        schema:
          type: integer
      - in: query
        name: sort
        description: 'One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at'
        schema:
          type: string
          enum:
          - title
          - status
          - created_at
          - updated_at
      - in: query
        name: order
        description: A sorting direction
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      - in: query
        name: title
        description: Filter by title
        schema:
          type: string
      - in: query
        name: section_type
        description: Filter by section_type
        schema:
          type: string
          enum:
          - section
          - slide
      - in: query
        name: view_type
        description: Filter by view_type
        schema:
          type: string
          enum:
          - drilling
          - discover
          - completion
          - geoscience
      operationId: getV2AppStoreTemplateSections
      x-operation-id-source: derived
    post:
      summary: Create a AppStoreTemplateSection
      tags:
      - AppStoreTemplateSections
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          description: Created AppStoreTemplate
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppStoreTemplateSectionObject'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppStoreTemplateSectionPayload'
        description: AppStoreTemplateSection Payload
        required: true
      operationId: postV2AppStoreTemplateSections
      x-operation-id-source: derived
  /v2/app_store_template_section/{id}:
    get:
      summary: Show AppStoreTemplateSection
      tags:
      - AppStoreTemplateSections
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          type: object
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppStoreTemplateSectionObject'
      parameters:
      - in: path
        name: id
        description: AppStoreTemplateSection ID
        required: true
        schema:
          type: integer
          format: int64
      operationId: getV2AppStoreTemplateSectionById
      x-operation-id-source: derived
    patch:
      summary: Update a AppStoreTemplateSection
      tags:
      - AppStoreTemplateSections
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          description: Updated AppStoreTemplateSection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppStoreTemplateSectionObject'
      parameters:
      - in: path
        name: id
        description: AppStoreTemplateSection ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppStoreTemplateSectionPayload'
        description: AppStoreTemplateSection Payload
        required: true
      operationId: patchV2AppStoreTemplateSectionById
      x-operation-id-source: derived
    delete:
      summary: Delete a AppStoreTemplateSection
      tags:
      - AppStoreTemplateSections
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          description: AppStoreTemplateSection deleted
      parameters:
      - in: path
        name: id
        description: AppStoreTemplateSection ID
        required: true
        schema:
          type: integer
      operationId: deleteV2AppStoreTemplateSectionById
      x-operation-id-source: derived
components:
  schemas:
    AppStoreTemplateSectionObject:
      properties:
        id:
          type: integer
          format: int64
        type:
          type: string
        attributes:
          type: object
          properties:
            id:
              type: integer
              format: int64
            title:
              type: string
            section_type:
              type: string
            view_type:
              type: string
            position:
              type: integer
            created_at:
              type: string
              format: date-time
            updated:
              type: string
              format: date-time
        relationships:
          type: object
          properties:
            app_store_template:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
            apps:
              type: object
              properties:
                data:
                  type: array
                  items:
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
            workflows:
              type: object
              properties:
                data:
                  type: array
                  items:
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
            app_store_template_apps:
              type: object
              properties:
                data:
                  type: array
                  items:
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                      app_id:
                        type: integer
                      workflow_id:
                        type: integer
            app_store_articles:
              type: object
              properties:
                data:
                  type: array
                  items:
                    properties:
                      id:
                        type: integer
                        format: int64
                      caption:
                        type: string
                      name:
                        type: string
                      position:
                        type: integer
                      overview:
                        type: text
                      cover_url:
                        type: string
                      text:
                        type: text
                      date:
                        type: string
                        format: date-time
                      visibility:
                        type: string
                      app_store_template_section_id:
                        type: integer
                        format: int64
            banner:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
      example:
        id: 12345
        type: app_store_template_section
        attributes:
          id: 12345
          title: AppStore Template Section
          section_type: slide
          view_type: drilling
          position: 1
          created_at: '2022-11-11T09:11:52.326Z'
          updated_at: '2022-11-11T09:11:52.326Z'
        relationships:
          app_store_template:
            data:
              id: 12345
              type: app_store_template
          apps:
            data:
            - id: 12345
              type: app
          workflows:
            data:
            - id: 12345
              type: workflow
          app_store_template_apps:
            data:
            - id: 12345
              type: app_store_template_app
              app_id: 1
              workflow_id: 2
          app_store_articles:
            data:
            - id: 12345
              type: app_store_article
              caption: Caption
              name: Article name
              position: 1
              visibility: public
              overview: Overview text
              text: Content text
              date: '2022-11-11T09:11:52.326Z'
              cover_url: https://example.com
              app_store_template_section_id: 1
          banner:
            data:
              id: 12345
              featured_title: Featured Title
              header: Header
              subheader: Sub header
              url: https://example.com/foo/bar
              custom_image_url: aws_image_url
              created_at: '2022-11-11T09:11:52.326Z'
              updated_at: '2022-11-11T09:11:52.326Z'
    AuthorizationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 403
        message: Access denied
    AppStoreTemplateSectionList:
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AppStoreTemplateSectionObject'
        included:
          type: array
          items:
            properties:
              id:
                type: integer
              type:
                type: string
              attributes:
                type: object
      example:
        data:
        - id: 12345
          type: app_store_template_section
          attributes:
            id: 12345
            title: AppStore Template Section
            section_type: slide
            view_type: drilling
            position: 1
            created_at: '2022-11-11T09:11:52.326Z'
            updated_at: '2022-11-11T09:11:52.326Z'
          relationships:
            app_store_template:
              data:
                id: 12456
                type: app_store_template
            apps:
              data:
              - id: 12456
                type: app
              - id: 345
                type: app
            workflows:
              data:
              - id: 12456
                type: workflow
              - id: 345
                type: workflow
        included:
        - id: 348
          type: app_store_template
          attributes:
            id: 348
            title: Title
            status: draft
        - id: 349
          type: app
          attributes:
            id: 348
            name: App name
            app_key: App Key
            description: Description
            summary: Summary
        - id: 349
          type: workflow
          attributes:
            id: 348
            name: Workflow name
            caption: Caption
            overview: Overview
            apps:
            - 1
            - 2
        - id: 349
          type: app_store_template_app
          attributes:
            id: 348
            image_url: https://example.com/some/image/url
            position: 1
            app_id: 123
            workflow_id: null
    AuthenticationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 401
        message: Missing authentication. Please try again.
    NotFoundError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 404
        message: Not found
    AppStoreTemplateSectionPayload:
      properties:
        app_store_template_section:
          type: object
          properties:
            title:
              type: string
            section_type:
              type: string
            position:
              type: integer
            app_ids:
              type: array
            workflow_ids:
              type: array
            banner_ids:
              type: array
            app_store_article_keys:
              type: array
            app_store_template_apps_attributes:
              type: object
              properties:
                image_url:
                  type: string
                app_key:
                  type: string
                workflow_id:
                  type: integer
            app_store_articles_attributes:
              type: object
              properties:
                caption:
                  type: string
                name:
                  type: string
                overview:
                  type: text
                cover_url:
                  type: string
                text:
                  type: text
                date:
                  type: string
                  format: date-time
                visibility:
                  type: string
                position:
                  type: integer
            banner_attributes:
              type: object
              properties:
                featured_title:
                  type: string
                header:
                  type: string
                subheader:
                  type: string
                url:
                  type: string
                custom_image_url:
                  type: string
      example:
        app_store_template_section:
          title: New title
          section_type: slide
          position: 1
          app_ids:
          - 1
          - 2
          - 3
          workflow_ids:
          - 1
          - 2
          - 3
          banner_ids:
          - 1
          app_store_article_keys:
          - provider.article_name
          app_store_template_apps_attributes:
          - image_url: https://www.example.com/image.jpg
            app_key: app_key1
          - image_url: https://www.example.com/image.jpg
            app_key: app_key2
          - image_url: https://www.example.com/image.jpg
            workflow_id: 1
          app_store_articles_attributes:
          - caption: Caption
            name: Article name
            visibility: public
          banner_attributes:
            featured_title: Featured Title
            header: Header
            subheader: Sub header
            url: https://example.com/foo/bar
            custom_image_url: aws_image_url
  securitySchemes:
    api_key:
      type: apiKey
      name: authorization
      in: header