openapi: 3.2.0
info:
  title: CoreStack External Master Data API
  version: 1.0.0
  termsOfService: http://corestack.io/
  license:
    name: CoreStack Inc License
    url: http://corestack.io/licenses/LICENSE-2.0.html
  description: Master Data apis
servers:
- url: /
tags:
- name: Master Data
  description: Master Data apis
paths:
  /v1/master_data/categories/list:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MasterDataCategoryListResponse'
      summary: List Master data
      description: List Master Data Categories
      operationId: ListMasterDataCategories
      security:
      - auth_token: []
      tags:
      - Master Data
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MasterDataCategoryListRequest'
        required: true
components:
  schemas:
    ListContext:
      properties:
        batch_size:
          type: integer
          description: Max number of ids in the response
        batch_offset:
          type: integer
          description: Offset of batches into the results. First batch is 0
        total:
          type: integer
          description: Total number of results
      type: object
    MasterDataCategoryDetails:
      properties:
        cloud:
          type: string
          description: 'Cloud provider (eg : AWS, Azure, GCP & OCI)'
        service_code:
          type: string
          description: Service Code that is provided by Cloud provider
        service_name:
          type: string
          description: Services Name that is provided by Cloud provider
        display_name:
          type: string
          description: Display Name that is provided by Cloud provider
        description:
          type: string
          description: Short Description that is provided by Cloud provider
        generalized_category:
          type: string
          description: Service Category defined by Corestack based on Service Code and FOCUS Specification
        service_category:
          type: string
          description: Service Category defined by Cloud provider
        service_type:
          type: string
          description: 'Service Type defined by Corestack based on the Service Code (eg : Iaas, PaaS, SaaS, ....)'
        service_sub_category:
          type: string
          description: Filter By service_sub_category
      type: object
    MasterDataCategoryListRequest:
      properties:
        list_context:
          description: Optional list context
          $ref: '#/components/schemas/ListContext'
        filters:
          description: Filters for the request
          $ref: '#/components/schemas/MasterDataCategoryFilters'
      type: object
    ModelError:
      required:
      - message
      properties:
        message:
          type: string
          description: Error response message.
      type: object
    MasterDataCategoryListResponse:
      properties:
        results:
          type: array
          description: Master Data Category List
          items:
            $ref: '#/components/schemas/MasterDataCategoryDetails'
        next_list_context:
          description: List context
          $ref: '#/components/schemas/ListContext'
      type: object
    MasterDataCategoryFilters:
      properties:
        cloud:
          type: array
          description: Filter By cloud
          items:
            type: string
        service_code:
          type: array
          description: Filter By service_code
          items:
            type: string
        service_name:
          type: array
          description: Filter By service_name
          items:
            type: string
        display_name:
          type: array
          description: Filter By display_name
          items:
            type: string
        generalized_category:
          type: array
          description: Filter By generalized_category
          items:
            type: string
        service_category:
          type: array
          description: Filter By service_category
          items:
            type: string
        service_type:
          type: array
          description: Filter By service_type
          items:
            type: string
        service_sub_category:
          type: array
          description: Filter By service_sub_category
          items:
            type: string
      type: object
  securitySchemes:
    auth_token:
      type: apiKey
      in: header
      name: X-Auth-Token