ReplySandboxOpenApi.yaml

openapi: 3.0.1
info:
  title: SaaS server mock
  description: >-
    For more details and full context regarding SaaS server mock. Mock can be configured to return custom headers, body and status code for specified company. Default company is 0. After headers/body/status code is set, server will return specified values on all endpoints.
    services, consult documentation at:
    https://confluence.quadient.group/display/PROD/PRODaaS+cloud+proxy+mock
  version: 14.4.202.0
paths:
  /{companyId}:
    get:
      parameters:
        - in: path
          name: companyId   # Note the name is the same as in the path
          required: true
          schema:
            type: integer
            minimum: 0
          description: CompanyId - specified response will be returned for the company. Without company specification it will return setting which is configured for company 0.   
      responses:
        '200':
          description: Default value is 200, but can be configured
          headers:
            configuredHeaders:
              schema:
                type: string
              description: Default headers are just http required headers
          content:
            application/json:
              schema:
                type: object
                properties:
                  body:
                    type: string
                    description: whole body can be configured, default value is empty body

    parameters:
      - name: Bearer
        in: header
        description: At the moment, it is not required and used, company is enriched from the first url path (ex. sandboxurlport/101002/blah/halb -> 101002 is company id)
        schema:
          type: string

  /setHeaders:
    post:
      parameters:
        - name: CompanyId
          in: header
          description:  CompanyId which will be used to pair headers with response to specific company, if not specified "0" will be used - "0" is the fallback for all responses
          schema:
            type: string
        - name: CustomHeader1
          in: header
          description:  Any number of headers which will be then returned on root endpoint
          schema:
            type: string
        - name: CustomHeader2
          in: header
          description:  Any number of headers which will be then returned on root endpoint
          schema:
            type: string
      responses:
        '200':
          description: OK
      description: Headers are stored per company, if present, CompanyId header will be used. This endpoint can be used for setting up the headers, which will be used on root get endpoint (also all the paths which are not confired as valid endpoints will return configured values). Any previously saved headers are replaced. 

  /setBody:
    post:
      parameters: 
        - name: CompanyId
          in: header
          description:  CompanyId which will be used to pair body with response to specific company, if not specified "0" will be used - "0" is the fallback for all responses
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                body:
                  type: string
                  description: Whole body without any modification is saved and used.
      responses:
        '200':
          description: OK
      description: Body is stored per company, if present, CompanyId header will be used. This endpoint can be used for setting up the body, which will be used on root get endpoint (also all the paths which are not confired as valid endpoints will return configured values). Whole body which is send to this endpoint will be saved and used. Any previously saved body is replaced.
  
  /setStatusCode:
    post:
      parameters:
        - name: CompanyId
          in: header
          description:  CompanyId which will be used to pair statuscode with response to specific company, if not specified "0" will be used - "0" is the fallback for all responses
          schema:
            type: string
        - name: statuscode
          in: query
          required: true
          description:  Http response status code integer - 100-500
          schema:
            type: string
      responses:
        '200':
          description: OK
      description: Status code is stored per company, if present, CompanyId header will be used. This endpoint can be used for setting up the response status code, which will be used on root GET endpoint (also all the paths which are not confired as valid endpoints will return configured values). 
      
  /setHeadersAndBody:
    post:
      parameters:
        - name: CompanyId
          in: header
          description:  CompanyId which will be used to pair headers and body with response to specific company, if not specified "0" will be used - "0" is the fallback for all responses
          schema:
            type: string
        - name: CustomHeader1
          in: header
          description:  Any number of headers which will be then returned on root endpoint
          schema:
            type: string
        - name: CustomHeader2
          in: header
          description:  Any number of headers which will be then returned on root endpoint
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                body:
                  type: string
                  description: Whole body without any modification is saved and used.
      responses:
        '200':
          description: OK
      description: Headers and body are stored per company, if present, CompanyId header will be used.This endpoint can be used for setting up the body and headers, which will be used on root GET endpoint (also all the paths which are not confired as valid endpoints will return configured values). Whole body which is send to this endpoint will be saved and used, and also all the headers. Any previously saved headers and body are replaced.
      
  /setEverything:
    post:
      parameters:
        - name: CompanyId
          in: header
          description:  CompanyId which will be used to pair headersm, body and statusCode with response to specific company, if not specified "0" will be used - "0" is the fallback for all responses
          schema:
            type: string
        - name: CustomHeader1
          in: header
          description:  Any number of headers which will be then returned on root endpoint
          schema:
            type: string
        - name: CustomHeader2
          in: header
          description:  Any number of headers which will be then returned on root endpoint
          schema:
            type: string

        - name: statuscode
          in: query
          description:  Http response status code integer - 100-500 (just one header)
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                body:
                  type: string
                  description: Whole body without any modification is saved and used.
      responses:
        '200':
          description: OK
      description: Headers and body are stored per company, if present, CompanyId header will be used.This endpoint can be used for setting up the body and headers, which will be used on root GET endpoint (also all the paths which are not confired as valid endpoints will return configured values). Whole body which is send to this endpoint will be saved and used, and also all the headers. Any previously saved headers and body are replaced.

  /clear:
    post:
      parameters:
        - name: CompanyId
          in: header
          required : true
          description:  CompanyId which will be used to delete company specific setting, if not specified, all settings will be deleted
          schema:
            type: string
      responses:
        '200':
          description: OK
      description: This endpoint will reset any previous setting of headers,body and status code for every company.

  /reflect:
    post:
      parameters:
        - name: CustomHeaders
          in: header
          description:  Any number of headers which will be then returned in response.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                body:
                  type: string
                  description: Whole body without any modification will be returned in response.
      responses:
        '200':
          description: Will return headers and body which it received.
      description: This endpoint will respond with the headers and body which it receives.
      
  /bob/api/v1/service/instance/list:
    get:
      responses:
        '200':
          description: Will return static headers and body which are set up in the server compilation time.
      description: This endpoint will all ways return predefined body (compile time defined).
      
  /bob/api/v1/service/definition/listVisible:
    get:
      responses:
        '200':
          description: Will return static headers and body which are set up in the server compilation time.
      description: This endpoint will all ways return predefined body (compile time defined).