custom_endpoints.yaml

openapi: 3.0.0
info:
  title: Help Center API
  version: 1.0.0
  description: API documentation for the Help Center application
servers:
  - url: http://127.0.0.1:8000
    description: Local server
  - description: Subscription Plan and Feature
    url: https://virtserver.swaggerhub.com/bhimbho/SubPlanFeature/1.0.0
tags:
  - name: help-center
    description: Help Center API operations
  - name: features
    description: Feature operations
  - name: plans
    description: Plan operations
paths:
  /api/v1/help-center/topics/search:
    get:
      tags:
        - help-center
      summary: Search help center topics
      description: Retrieves articles based on the search query provided in the title parameter
      parameters:
        - name: title
          in: query
          required: true
          schema:
            type: string
          description: The title or part of the title of the article to search for
      responses:
        '200':
          description: A list of articles matching the search query
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Articles found
                  status_code:
                    type: integer
                    example: 200
                  topics:
                    type: array
                    items:
                      type: object
                      properties:
                        article_id:
                          type: string
                          example: "3e8b8c0-d1ca-4b9e-a97f-d4c2413ac930"
                        author:
                          type: string
                          example: Clifton Satterfield
                        title:
                          type: string
                          example: How to update your profile
                        content:
                          type: string
                          example: To update your profile, go to the settings page...
        '400':
          description: Bad request, possibly due to missing or invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: Invalid request parameters
                  status_code:
                    type: integer
                    example: 400
        '429':
          description: Too many requests due to rate limiting
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: Too many requests, please try again later
                  status_code:
                    type: integer
                    example: 429
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: Internal server error
                  status_code:
                    type: integer
                    example: 500
  /features:
    post:
      tags:
        - features
      summary: creates a feature for reuse
      operationId: addFeature
      description: creates a feature for reuse
      responses:
        '201':
          description: feature created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Features'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Unauthenticated
        '422':
          description: validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: one or more validation errors
                  errors:
                    type: array
                    items:
                      properties:
                        name:
                          type: string
                          example: name field required
        '400':
          description: feature creation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: feature creation failed
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeaturesInput'
        description: Inventory item to add
  /plans:
    post:
      tags:
        - plans
      summary: creates a subscription plan
      operationId: addplan
      description: Adds an item to the system
      responses:
        '201':
          description: subscription plan created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionPlan'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Unauthenticated
        '422':
          description: validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: one or more validation errors
                  errors:
                    type: array
                    items:
                      properties:
                        name:
                          type: string
                          example: name field required
        '400':
          description: creation of subscription plan failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: creation of subscription plan failed
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionPlanInput'
        description: Inventory item to add
components:
  schemas:
    SubscriptionPlan:
      type: object
      required:
        - name
        - price
        - duration
        - description
      properties:
        id:
          type: string
          format: uuid
          example: d290f1ee-6c54-4b01-90e6-d701748f0851
        name:
          type: string
          example: basic
        price:
          type: integer
          example: 1000
        duration:
          type: string
          example: monthly
        description:
          type: string
          example: this plan is valid for one month with extra 3days
        features:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/Features'
    Features:
      required:
        - name
        - status
      properties:
        name:
          type: string
          example: 2TB space
        description:
          type: string
          format: string
          example: 'xeoo'
        status:
          type: integer
          description: Status of the feature (can only be 1 or 0)
          example: 1
        status_text:
          type: string
          description: Status text of the feature (can only be active or inactive)
          example: active
    SubscriptionPlanInput:
      type: object
      required:
        - name
        - price
        - duration
        - description
      properties:
        id:
          type: string
          format: uuid
          example: d290f1ee-6c54-4b01-90e6-d701748f0851
        name:
          type: string
          example: basic
        price:
          type: integer
          example: 1000
        duration:
          type: string
          example: monthly
        description:
          type: string
          example: this plan is valid for one month with extra 3days
        features:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
                example: xxxx-xxxxx-xxxxx-xxxxxx
              status:
                type: string
                example: 1 for active 0 for inactive
    FeaturesInput:
      required:
        - name
        - status
      properties:
        name:
          type: string
          example: 2TB space
        description:
          type: string
          format: string
          example: 'xeoo'