swagger: '2.0'
info:
  description: Configuration for AF API Geo Location Report table resource.
  version: 'v2'
  title: api_geolocation
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: api_geolocation
    description: AF API Geo Location Report table
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  authParam:
      in: header
      name: Authorization
      type: string
      required: true
      description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
  cloudParam:
      in: header
      name: isCloud
      type: string
      required: true
      description: set the value to true in case of Cloud services, false for on-prem deployment
paths:
  /massvc/{customerid}/nitro/v2/config/api_geolocation:
    get:
      tags:
        - api_geolocation
      summary: GET all api_geolocation
      operationId: getall_api_geolocation
      description: AF API Geo Location Report table.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: query
          name: filter
          type: string
          required: false
          description: "Use this query-parameter to get the filtered set of vm_device resources configured on the system. You can set a filter on any property of the resource.Example:  property-name1:property-value1 "
        - in: query
          name: args
          type: string
          required: false
          description: "Use this query-parameter to specify arguments.Example:  property-name1:property-value1 "
        - in: query
          name: duration
          type: string
          required: true
          description: "Duration "
          enum:
            - last_1_hour
            - last_1_day
            - last_1_week
            - last_1_month
        - in: query
          name: report_start_time
          type: string
          required: false
          description: Use this query-parameter to specify the start time from which the summary for report is considered
        - in: query
          name: report_end_time
          type: string
          required: false
          description: Use this query-parameter to specify the end time until where summary for report is considered
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the api_geolocation resources in chunks.To be used along with pageno query parameter.
        - in: query
          name: pageno
          type: integer
          required: false
          description: Use this query-parameter to get the api_geolocation resources in chunks.To be used along with pagesize query parameter.
        - in: query
          name: count
          type: string
          required: false
          description: Use this query-parameter to get the count of api_geolocation resources.
          enum:
            - yes
      responses:
        200:
          description:  for api_geolocation
          schema: 
              $ref: '#/definitions/getapi_geolocationsResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

definitions:
  getapi_geolocationResponse:
    type: object
    required:
      - api_geolocation
    properties:
      api_geolocation:
        $ref: '#/definitions/api_geolocation'
    title: getapi_geolocationResponse
    example:
      api_geolocation:
        response_time: "0"
        latitude: "12.976750"
        api_endpoint: "/api/employee/3"
        longitude: "77.575279"
        region_code: "KA"
        api_instance: "test_vserver"
        region: "Karnataka"
        total_bytes: "0"
        total_country: "0"
        country: "India"
        rpt_sample_time: "0"
        __count: "0"
        country_code: "IN"
        http_req_method_name: "GET"
        city: "Bengaluru"
        max_response_time: "0"
        total_requests: "0"

  getapi_geolocationsResponse:
    type: object
    required:
      - api_geolocation
    properties:
      api_geolocation:
        type: array
        items:
          $ref: '#/definitions/api_geolocation'
    title: getapi_geolocationsResponse
    example:
      api_geolocation:
        response_time: "0"
        latitude: "12.976750"
        api_endpoint: "/api/employee/3"
        longitude: "77.575279"
        region_code: "KA"
        api_instance: "test_vserver"
        region: "Karnataka"
        total_bytes: "0"
        total_country: "0"
        country: "India"
        rpt_sample_time: "0"
        __count: "0"
        country_code: "IN"
        http_req_method_name: "GET"
        city: "Bengaluru"
        max_response_time: "0"
        total_requests: "0"

  api_geolocation_readwrite:
    type: object
    properties:
      response_time:
        description: "Response time."
        type: number
        format: double
      latitude:
        description: "Latitude"
        type: number
        format: double
      api_endpoint:
        description: "API Endpoint Name"
        type: string
        format: string
        maxLength: 255
      longitude:
        description: "Longitude"
        type: number
        format: double
      region_code:
        description: "Region Code"
        type: string
        format: string
      api_instance:
        description: "API Instance Name"
        type: string
        format: string
        maxLength: 255
      region:
        description: "Region Name"
        type: string
        format: string
      total_bytes:
        description: "Maximum Total Bytes."
        type: number
        format: double
      total_country:
        description: "Total Country in given sampled timeframe."
        type: number
        format: double
      country:
        description: "Country Name"
        type: string
        format: string
      rpt_sample_time:
        description: "Report Sample time."
        type: number
        format: double
      __count:
        description: "count."
        type: number
        format: double
      country_code:
        description: "Country Code"
        type: string
        format: string
      http_req_method_name:
        description: "HTTP Request Method."
        type: string
        format: string
        maxLength: 30
      city:
        description: "City Name"
        type: string
        format: string
      max_response_time:
        description: "Maximum Response Time in sampled timeframe."
        type: number
        format: double
      total_requests:
        description: "Total Requests in given sampled timeframe."
        type: number
        format: double

  api_geolocation:
    allOf:
      - $ref: '#/definitions/api_geolocation_readwrite'

  Error:
    properties:
      errorcode:
        type: number
        format: int32
        example: 1001
      errormessage:
        type: string
        format: string
        example: "id cannot be found"
