github.com/optim-corp/cios-golang-sdk@v0.5.1/openapi/openapis/geography.openapi.yml (about)

     1  openapi: "3.0.3"
     2  info:
     3    version: 1.0.0
     4    title: Cios Geography Openapi
     5  
     6  paths:
     7    '/v2/geo/points':
     8      get:
     9        tags:
    10          - geography
    11        operationId: getPoints
    12        parameters:
    13          - $ref: "../components/parameters.yml#/components/parameters/name_query"
    14          - $ref: "../components/parameters.yml#/components/parameters/label"
    15          - $ref: "../components/parameters.yml#/components/parameters/is_public"
    16          - $ref: "../components/parameters.yml#/components/parameters/resource_owner_id"
    17          - $ref: "../components/parameters.yml#/components/parameters/sort"
    18          - $ref: "../components/parameters.yml#/components/parameters/top"
    19          - $ref: "../components/parameters.yml#/components/parameters/skip"
    20          - $ref: "../components/parameters.yml#/components/parameters/lang"
    21          - $ref: "../components/parameters.yml#/components/parameters/is_dev"
    22        responses:
    23          200:
    24            description: ''
    25            content:
    26              application/json:
    27                schema:
    28                  $ref: "../components/geography-component.openapi.yml#/components/schemas/MultiplePoint"
    29        security:
    30          - bearerAuth: []
    31      post:
    32        tags:
    33          - geography
    34        operationId: createPoint
    35        requestBody:
    36          content:
    37            application/json:
    38              schema:
    39                $ref: '../components/geography-component.openapi.yml#/components/schemas/PointRequest'
    40          required: true
    41        responses:
    42          200:
    43            description: ''
    44            content:
    45              application/json:
    46                schema:
    47                  $ref: "../components/geography-component.openapi.yml#/components/schemas/SinglePoint"
    48        security:
    49          - bearerAuth: []
    50    '/v2/geo/points/{point_id}':
    51      get:
    52        tags:
    53          - geography
    54        operationId: getPoint
    55        parameters:
    56          - $ref: "../components/parameters.yml#/components/parameters/point_id_required"
    57          - $ref: "../components/parameters.yml#/components/parameters/lang"
    58          - $ref: "../components/parameters.yml#/components/parameters/is_dev"
    59        responses:
    60          200:
    61            description: ''
    62            content:
    63              application/json:
    64                schema:
    65                  $ref: "../components/geography-component.openapi.yml#/components/schemas/SinglePoint"
    66        security:
    67          - bearerAuth: []
    68      patch:
    69        tags:
    70          - geography
    71        operationId: updatePoint
    72        parameters:
    73          - $ref: "../components/parameters.yml#/components/parameters/point_id_required"
    74        requestBody:
    75          content:
    76            application/json:
    77              schema:
    78                type: array
    79                items:
    80                  $ref: "../components/general.yml#/components/schemas/DisplayInfo"
    81        responses:
    82          200:
    83            description: ''
    84            content:
    85              application/json:
    86                schema:
    87                  $ref: "../components/geography-component.openapi.yml#/components/schemas/SinglePoint"
    88        security:
    89          - bearerAuth: []
    90      delete:
    91        tags:
    92          - geography
    93        operationId: deletePoint
    94        parameters:
    95          - $ref: "../components/parameters.yml#/components/parameters/point_id_required"
    96        responses:
    97          200:
    98            description: ''
    99            content:
   100              application/json:
   101                schema:
   102                  $ref: "../components/geography-component.openapi.yml#/components/schemas/SinglePoint"
   103        security:
   104          - bearerAuth: []
   105    '/v2/geo/circles':
   106      get:
   107        tags:
   108          - geography
   109        operationId: getCircles
   110        parameters:
   111          - $ref: "../components/parameters.yml#/components/parameters/name_query"
   112          - $ref: "../components/parameters.yml#/components/parameters/label"
   113          - $ref: "../components/parameters.yml#/components/parameters/is_public"
   114          - $ref: "../components/parameters.yml#/components/parameters/resource_owner_id"
   115          - $ref: "../components/parameters.yml#/components/parameters/sort"
   116          - $ref: "../components/parameters.yml#/components/parameters/top"
   117          - $ref: "../components/parameters.yml#/components/parameters/skip"
   118          - $ref: "../components/parameters.yml#/components/parameters/lang"
   119          - $ref: "../components/parameters.yml#/components/parameters/is_dev"
   120        responses:
   121          200:
   122            description: ''
   123            content:
   124              application/json:
   125                schema:
   126                  $ref: "../components/geography-component.openapi.yml#/components/schemas/MultipleCircle"
   127        security:
   128          - bearerAuth: []
   129      post:
   130        tags:
   131          - geography
   132        operationId: createCircle
   133        requestBody:
   134          required: true
   135          content:
   136            application/json:
   137              schema:
   138                $ref: '../components/geography-component.openapi.yml#/components/schemas/Circle'
   139        responses:
   140          200:
   141            description: ''
   142            content:
   143              application/json:
   144                schema:
   145                  $ref: "../components/geography-component.openapi.yml#/components/schemas/SingleCircle"
   146        security:
   147          - bearerAuth: []
   148    '/v2/geo/circles/{circles_id}':
   149      get:
   150        tags:
   151          - geography
   152        operationId: getCircle
   153        parameters:
   154          - $ref: "../components/parameters.yml#/components/parameters/circle_id_required"
   155          - $ref: "../components/parameters.yml#/components/parameters/lang"
   156          - $ref: "../components/parameters.yml#/components/parameters/is_dev"
   157        responses:
   158          200:
   159            description: ''
   160            content:
   161              application/json:
   162                schema:
   163                  $ref: "../components/geography-component.openapi.yml#/components/schemas/SingleCircle"
   164        security:
   165          - bearerAuth: []
   166      patch:
   167        tags:
   168          - geography
   169        operationId: updateCircle
   170        parameters:
   171          - $ref: "../components/parameters.yml#/components/parameters/circle_id_required"
   172        requestBody:
   173          content:
   174            application/json:
   175              schema:
   176                type: array
   177                items:
   178                  $ref: "../components/general.yml#/components/schemas/DisplayInfo"
   179        responses:
   180          200:
   181            description: ''
   182            content:
   183              application/json:
   184                schema:
   185                  $ref: "../components/geography-component.openapi.yml#/components/schemas/SingleCircle"
   186        security:
   187          - bearerAuth: []
   188      delete:
   189        tags:
   190          - geography
   191        operationId: deleteCircle
   192        parameters:
   193          - $ref: "../components/parameters.yml#/components/parameters/circle_id_required"
   194        responses:
   195          200:
   196            description: ''
   197        security:
   198          - bearerAuth: []
   199    '/v2/geo/routes':
   200      get:
   201        tags:
   202          - geography
   203        operationId: getRoutes
   204        parameters:
   205          - $ref: "../components/parameters.yml#/components/parameters/name_query"
   206          - $ref: "../components/parameters.yml#/components/parameters/label"
   207          - $ref: "../components/parameters.yml#/components/parameters/is_public"
   208          - $ref: "../components/parameters.yml#/components/parameters/resource_owner_id"
   209          - $ref: "../components/parameters.yml#/components/parameters/sort"
   210          - $ref: "../components/parameters.yml#/components/parameters/top"
   211          - $ref: "../components/parameters.yml#/components/parameters/skip"
   212          - $ref: "../components/parameters.yml#/components/parameters/lang"
   213          - $ref: "../components/parameters.yml#/components/parameters/is_dev"
   214        responses:
   215          200:
   216            description: ''
   217            content:
   218              application/json:
   219                schema:
   220                  $ref: "../components/geography-component.openapi.yml#/components/schemas/MultipleRoute"
   221        security:
   222          - bearerAuth: []
   223      post:
   224        tags:
   225          - geography
   226        operationId: createRoute
   227        requestBody:
   228          content:
   229            application/json:
   230              schema:
   231                $ref: '../components/geography-component.openapi.yml#/components/schemas/Route'
   232          required: true
   233        responses:
   234          200:
   235            description: ''
   236            content:
   237              application/json:
   238                schema:
   239                  $ref: "../components/geography-component.openapi.yml#/components/schemas/SingleRoute"
   240        security:
   241          - bearerAuth: []
   242    '/v2/geo/routes/{routes_id}':
   243      get:
   244        tags:
   245          - geography
   246        operationId: getRoute
   247        parameters:
   248          - $ref: "../components/parameters.yml#/components/parameters/route_id_required"
   249          - $ref: "../components/parameters.yml#/components/parameters/lang"
   250          - $ref: "../components/parameters.yml#/components/parameters/is_dev"
   251        responses:
   252          200:
   253            description: ''
   254            content:
   255              application/json:
   256                schema:
   257                  $ref: "../components/geography-component.openapi.yml#/components/schemas/SingleRoute"
   258        security:
   259          - bearerAuth: []
   260      patch:
   261        tags:
   262          - geography
   263        operationId: updateRoute
   264        parameters:
   265          - $ref: "../components/parameters.yml#/components/parameters/route_id_required"
   266        requestBody:
   267          content:
   268            application/json:
   269              schema:
   270                type: array
   271                items:
   272                  $ref: "../components/general.yml#/components/schemas/DisplayInfo"
   273        responses:
   274          200:
   275            description: ''
   276            content:
   277              application/json:
   278                schema:
   279                  $ref: "../components/geography-component.openapi.yml#/components/schemas/SingleRoute"
   280        security:
   281          - bearerAuth: []
   282      delete:
   283        tags:
   284          - geography
   285        operationId: deleteRoute
   286        parameters:
   287          - $ref: "../components/parameters.yml#/components/parameters/route_id_required"
   288        responses:
   289          200:
   290            description: ''
   291        security:
   292          - bearerAuth: []
   293  
   294  components:
   295    securitySchemes:
   296      bearerAuth:
   297        type: http
   298        scheme: bearer
   299        bearerFormat: JWT