github.com/optim-corp/cios-golang-sdk@v0.5.1/openapi/components/publishsublish-component.openapi.yml (about)

     1  openapi: 3.0.3
     2  info:
     3    title: Pub/Sub Component
     4    description: Component
     5    version: 1.0.0
     6  
     7  paths: {}
     8  
     9  components:
    10    schemas:
    11      MultipleChannel:
    12        type: object
    13        properties:
    14          total:
    15            type: integer
    16            format: int64
    17          channels:
    18            type: array
    19            items:
    20              $ref: '#/components/schemas/Channel'
    21        required:
    22          - total
    23          - channels
    24      SingleChannel:
    25        type: object
    26        properties:
    27          channel:
    28            $ref: '#/components/schemas/Channel'
    29        required:
    30          - channel
    31      ChannelProposal:
    32        type: object
    33        properties:
    34          resource_owner_id:
    35            type: string
    36          channel_protocols:
    37            type: array
    38            items:
    39              $ref: '#/components/schemas/ChannelProtocol'
    40          display_info:
    41            type: array
    42            items:
    43              $ref: './general.yml#/components/schemas/DisplayInfo'
    44          labels:
    45            type: array
    46            items:
    47              $ref: './general.yml#/components/schemas/Label'
    48          messaging_config:
    49            $ref: '#/components/schemas/MessagingConfig'
    50          datastore_config:
    51            $ref: '#/components/schemas/DataStoreConfig'
    52        required:
    53          - resource_owner_id
    54          - display_info
    55      ChannelUpdateProposal:
    56        type: object
    57        properties:
    58          channel_protocols:
    59            type: array
    60            items:
    61              $ref: '#/components/schemas/ChannelProtocol'
    62          display_info:
    63            type: array
    64            items:
    65              $ref: './general.yml#/components/schemas/DisplayInfo'
    66          labels:
    67            type: array
    68            items:
    69              $ref: './general.yml#/components/schemas/Label'
    70          messaging_config:
    71            $ref: '#/components/schemas/MessagingConfig'
    72          datastore_config:
    73            $ref: '#/components/schemas/DataStoreConfig'
    74        required:
    75          - resource_owner_id
    76          - display_info
    77      Channel:
    78        type: object
    79        properties:
    80          id:
    81            type: string
    82          created_at:
    83            type: string
    84          updated_at:
    85            type: string
    86          resource_owner_id:
    87            type: string
    88          name:
    89            type: string
    90          description:
    91            type: string
    92          channel_protocols:
    93            type: array
    94            items:
    95              $ref: '#/components/schemas/ChannelProtocol'
    96          display_info:
    97            type: array
    98            items:
    99              $ref: './general.yml#/components/schemas/DisplayInfo'
   100          labels:
   101            type: array
   102            items:
   103              $ref: './general.yml#/components/schemas/Label'
   104          messaging_config:
   105            $ref: '#/components/schemas/MessagingConfig'
   106          datastore_config:
   107            $ref: '#/components/schemas/DataStoreConfig'
   108        required:
   109          - id
   110          - resource_owner_id
   111          - name
   112          - created_at
   113          - updated_at
   114      ChannelProtocol:
   115        type: object
   116        properties:
   117          id:
   118            type: string
   119          version:
   120            type: integer
   121          validation_required:
   122            type: boolean
   123  
   124      MessagingConfig:
   125        type: object
   126        properties:
   127          enabled:
   128            type: boolean
   129          persisted:
   130            type: boolean
   131      DataStoreConfig:
   132        type: object
   133        properties:
   134          enabled:
   135            type: boolean
   136          max_size:
   137            type: string
   138          max_count:
   139            type: string
   140      MultipleDataStoreChannel:
   141        type: object
   142        properties:
   143          total:
   144            type: integer
   145            format: int64
   146          channels:
   147            type: array
   148            items:
   149              $ref: '#/components/schemas/DataStoreChannel'
   150        required:
   151          - total
   152          - channels
   153      SingleDataStoreChannel:
   154        type: object
   155        properties:
   156          channel:
   157            $ref: '#/components/schemas/DataStoreChannel'
   158        required:
   159          - channel
   160      DataStoreChannel:
   161        type: object
   162        properties:
   163          id:
   164            type: string
   165          data_exist:
   166            type: boolean
   167          stats:
   168            type: object
   169            properties:
   170              count:
   171                type: string
   172              size:
   173                type: string
   174              latest_at:
   175                type: string
   176      MultipleDataStoreObject:
   177        type: object
   178        properties:
   179          total:
   180            type: integer
   181            format: int64
   182          objects:
   183            type: array
   184            items:
   185              $ref: '#/components/schemas/DataStoreObject'
   186        required:
   187          - total
   188          - objects
   189      SingleDataStoreObject:
   190        type: object
   191        properties:
   192          object:
   193            $ref: '#/components/schemas/DataStoreObject'
   194        required:
   195          - object
   196      DataStoreObject:
   197        required:
   198          - id
   199          - timestamp
   200          - mime_type
   201        type: object
   202        properties:
   203          id:
   204            type: string
   205          channel_protocols:
   206            type: array
   207            items:
   208              $ref: '#/components/schemas/ChannelProtocol'
   209          mime_type:
   210            type: string
   211          timestamp:
   212            type: string
   213          location:
   214            type: object
   215            properties:
   216              latitude:
   217                type: number
   218              longitude:
   219                type: number
   220              altitude:
   221                type: number
   222          session_id:
   223            type: string
   224      Ids:
   225        type: object
   226        properties:
   227          ids:
   228            type: array
   229            items:
   230              type: string
   231      MultipleDataStoreDataLatest:
   232        properties:
   233          total:
   234            type: number
   235          objects:
   236            type: array
   237            items:
   238              $ref: '#/components/schemas/PackerFormatJson'
   239          errors:
   240            type: array
   241            items:
   242              $ref: '#/components/schemas/DataError'
   243      DataError:
   244        properties:
   245          error_code:
   246            type: string
   247          id:
   248            type: string
   249          message:
   250            type: string
   251      PackerFormatJson:
   252        properties:
   253          header:
   254            $ref: '#/components/schemas/PackerFormatJsonHeader'
   255          payload: { }
   256        required:
   257          - payload
   258          - header
   259      PackerFormatJsonHeader:
   260        properties:
   261          channel_id:
   262            type: string
   263          channel_protocols:
   264            type: array
   265            items:
   266              $ref: '#/components/schemas/ChannelProtocol'
   267          timestamp:
   268            type: string
   269          session_id:
   270            type: string
   271          mime_type:
   272            enum: [ "text/plain","application/xml","application/json","application/octet-stream" ]
   273          labels:
   274            type: object
   275        required:
   276          - channel_id
   277          - timestamp
   278          - mime_type
   279      MultipleSession:
   280        type: object
   281        properties:
   282          total:
   283            type: integer
   284            format: int64
   285          sessions:
   286            type: array
   287            items:
   288              $ref: '#/components/schemas/Session'
   289      SingleSession:
   290        type: object
   291        properties:
   292          session:
   293            $ref: '#/components/schemas/Session'
   294      Session:
   295        type: object
   296        properties:
   297          id:
   298            type: string
   299          first:
   300            type: string
   301          last:
   302            type: string
   303          count:
   304            type: string