# This is an OpenAPI Specification (https://swagger.io/specification/)
# for the Hello World API
# owned by NHS Digital (https://digital.nhs.uk/)
openapi: "3.0.0"

info:
  version: "0.0.1"
  title: DPS Submission Api
  description: |
    ## Overview
    Use this API to submit data to DPS.

    ## Technology
    This API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#basic-rest-apis). And is available via the Internet, and over the [Health and Social Care Network (HSCN)](https://digital.nhs.uk/services/health-and-social-care-network). It also conforms to the [FHIR](https://digital.nhs.uk/developer/guides-and-documentation/introduction-to-apis#fhir) global standard for health care data exchange. Specifically, it is aligned with [FHIR UK Core](https://digital.nhs.uk/services/fhir-uk-core), which is built on FHIR Release 4.

    ## Authorisation
    This API is [Application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis) which means the calling application is authenticated rather than the end user. This API requires an API key presented in the 'apiKey' header along with the request.

    ## Sandbox Testing
    You can try out the sandbox using our Postman collection:
    [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/a31f8ef80a55c0226302)

    For more details on sandbox testing, see [Sandbox Testing](https://digital.nhs.uk/developer/guides-and-documentation/testing#sandbox-testing).

    ## Endpoints
    To see details for specific endpoints, select from the list on the left hand side of the page:
    - `POST /dps-submission-api`
  contact:
    name: API Management Support
    email: api.management@nhs.net

servers:
  - url: 'https://internal-dev.api.service.nhs.uk/dps-submission-api/'
    description: Sandbox environment.

paths:

  /dps-submission-api/:
    post:
      summary: Submit data and return 200 status to prove that it worked.
      operationId: submitDataToPDS
      description: |
        Get a 200 response from an application restriced endpoint.

      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: object
                    example: "{}"
      tags:
        - dps
components:

  securitySchemes:
    api_key:
      type: apiKey
      name: apikey
      in: header
  schemas:
    Greeting:
      $ref: components/schemas/ErrorCode.yaml