openapi: 3.2.0
info:
  title: CMS Common Facility Supporting Documentation APIs API
  description: MicroService that contains CMS related information
  contact:
    name: Ken Kracker
    email: ken.kracker@optum.com
  version: v1.0
servers:
- url: /v1/cmscommonms
tags:
- name: Supporting Documentation APIs
paths:
  /api/cms/facility/supporting-documents/:
    post:
      tags:
      - Supporting Documentation APIs
      summary: Fetches lists of data for supporting documentation
      operationId: getSupportingDocumentationDetails
      parameters:
      - name: sort
        in: query
        description: Any of these values (publicationType,-publicationType, postDate,-postDate,effectiveDate,-effectiveDate) are allowed. The default is -postDate
        required: false
        schema:
          type: array
          items:
            type: string
          default:
          - -postDate
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 50
        example: 150
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: yyyy-MM-dd
        in: header
        description: Date for which historical data is required
        required: false
        schema:
          type: string
          format: yyyy-MM-dd
      requestBody:
        description: Supporting documentation search request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SupportingDocument'
            examples:
              Supporting Documentation Search Request:
                description: Supporting Documentation Search Request
                value:
                  publicationType: ''
                  fileName: ''
                  publicationSubject: ''
                  postDate: ''
                  effectiveDate: ''
        required: true
      responses:
        '200':
          description: Post-for-GET - Fetch list of supporting documentation
          content:
            application/json:
              example:
                content:
                - docId: 2389
                  publicationType: MLN MATTERS
                  fileName: MM7134
                  heading: Fiscal Year (FY) 2011 Inpatient Prospective Payment System (IPPS), Long Term Care Hospital (LTCH) PPS, and Inpatient Psychiatric Facility (IPF) PPS Changes
                  postDate: '2010-10-01 00:00:00'
                  effectiveDate: '2010-10-01 00:00:00'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Notification'
              example:
                timestamp: '2024-05-18T06:37:03.741+00:00'
                status: 404
                error: Not Found
                message: Not Found
                path: /api/cms/facility/supporting-documents
        '500':
          description: Internal server error
          content:
            application/json:
              example:
                timestamp: '2024-05-28T06:36:22.518+00:00'
                path: /cmscommonms/api/cms/facility/supporting-documents/
                status: 500
                error: Internal Server Error
                requestId: e36d239e-324
      security:
      - bearerAuth: []
  /api/cms/facility/supporting-documents/{doc-id}/document-download:
    get:
      tags:
      - Supporting Documentation APIs
      summary: Fetches the file content for supporting documentation
      operationId: getSupportingDocumentPDF
      parameters:
      - name: doc-id
        in: path
        description: Supporting Document ID
        required: true
        schema:
          type: integer
          format: int32
        example: 633266
      - name: yyyy-MM-dd
        in: header
        description: Date for which historical data is required
        required: false
        schema:
          type: string
          format: yyyy-MM-dd
      responses:
        '200':
          description: Fetches The File Content in the form of byte array, response headers and media type as FileType
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/Notification'
              example: "  access-control-expose-headers: Content-Disposition\n  cache-control: no-cache,no-store,max-age=0,must-revalidate\n  connection: keep-alive\n  content-disposition: attachment; filename=Removal of Outdated Regulations.pdf\n  content-length: 254685\n  content-type: application/pdf\n  date: Thu,16 May 2024 06:49:56 GMT\n  expires: 0\n  pragma: no-cache\n  vary: Origin,Access-Control-Request-Method,Access-Control-Request-Headers\n  x-content-type-options: nosniff\n  x-frame-options: DENY\n  x-xss-protection: 0\n"
        '404':
          description: Not found- sub terms not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Notification'
              example:
                timestamp: '2023-07-28T06:19:48.666+00:00'
                status: 404
                error: Not Found
                message: Not Found
                path: /cmscommonms/api/cms/facility/supporting-documents/{docId}document-download
        '500':
          description: Internal server error
          content:
            application/json:
              example:
                timestamp: '2023-07-28T06:19:48.666+00:00'
                path: /cmscommonms/api/cms/facility/supporting-documents/{docId}document-download
                status: 500
                error: Internal Server Error
                requestId: a4796cc7-1
      security:
      - bearerAuth: []
components:
  schemas:
    SupportingDocument:
      type: object
      properties:
        docId:
          type: integer
          format: int32
        publicationType:
          type: string
        fileName:
          type: string
        publicationSubject:
          type: string
        postDate:
          type: string
        effectiveDate:
          type: string
    Notification:
      type: object
      properties:
        error:
          type: array
          items:
            type: string
        warning:
          type: array
          items:
            type: string
        info:
          type: array
          items:
            type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-readme:
  explorer-enabled: true
  proxy-enabled: true