Noyo Platform Group Structure API

openapi: 3.0.1
info:
  description: APIs to manage and consume information about Carriers
  title: Noyo Carrier Carrier Mapped Field Platform Group Structure API
  version: 1.0.0
servers: []
tags:
- name: Platform Group Structure
paths:
  /ui/v1/platform_group_structures/{platform_group_structure_id}/{version}:
    x-summary: Update a platform group structure
    put:
      description: Update a platform group structure based on the ID provided.
      operationId: updatePlatformGroupStructureUI
      parameters:
      - description: Unique identifier of the platform group structure you want to edit.
        in: path
        name: platform_group_structure_id
        required: true
        schema:
          example: 235bda1f-3f49-4502-be03-fd9179dfc10e
          format: uuid
          type: string
      - description: Unique version of the platform group structure you want to edit.
        in: path
        name: version
        required: true
        schema:
          example: 164c93ff-2101-4436-b187-125f73e965e2
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlatformGroupStructureUpdateRequestUI'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UIGroupPlatformGroupStructureResult'
          description: Successful Response - Returns the modified Platform Group Structure
      summary: Update a Platform Group Structure
      tags:
      - Platform Group Structure
components:
  schemas:
    PlatformStructurePlan:
      properties:
        carrier_id:
          format: uuid
          type: string
        custom_plan_id:
          nullable: true
          type: string
        id:
          format: uuid
          nullable: true
          type: string
        line_of_coverage:
          type: string
        name:
          nullable: true
          type: string
        temporals:
          items:
            $ref: '#/components/schemas/PlatformStructureTemporalPlan'
          type: array
      required:
      - carrier_id
      - line_of_coverage
      type: object
    PlatformStructure:
      properties:
        plans:
          items:
            $ref: '#/components/schemas/PlatformStructurePlan'
          nullable: true
          type: array
      type: object
    PlatformStructureTemporalPlan:
      properties:
        configuration:
          nullable: true
          type: string
        end_date:
          description: Temporal end date of the record
          example: '2020-01-01'
          format: date
          nullable: true
          type: string
        start_date:
          description: Temporal start date of the record
          example: '2019-01-01'
          format: date
          type: string
      type: object
    PlatformGroupStructureUpdateRequestUI:
      properties:
        created:
          description: The date the record was created
          type: integer
        group_id:
          description: Unique identifier of the group
          format: uuid
          type: string
        id:
          description: Unique identifier of the record in Noyo
          format: uuid
          type: string
        modified:
          description: The date the record was last updated
          type: integer
        organization_id:
          description: Unique identifier of the organization
          format: uuid
          type: string
        structure:
          $ref: '#/components/schemas/PlatformStructure'
        version:
          description: Current version of the record
          format: uuid
          type: string
      required:
      - created
      - group_id
      - id
      - modified
      - organization_id
      - version
      type: object
      x-field_order: []
    UIGroupPlatformGroupStructureResult:
      properties:
        created:
          description: The date the record was created
          type: integer
        group_id:
          description: Unique identifier of the group
          format: uuid
          type: string
        id:
          description: Unique identifier of the record in Noyo
          format: uuid
          type: string
        modified:
          description: The date the record was last updated
          type: integer
        organization_id:
          description: Unique identifier of the organization
          format: uuid
          type: string
        structure:
          $ref: '#/components/schemas/PlatformStructure'
        version:
          description: Current version of the record
          format: uuid
          type: string
      required:
      - created
      - group_id
      - id
      - modified
      - organization_id
      - version
      type: object
      x-field_order: []