"Fossies" - the Fresh Open Source Software Archive

Member "zaqar-10.0.0/api-ref/source/parameters.yaml" (13 May 2020, 17161 Bytes) of package /linux/misc/openstack/zaqar-10.0.0.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) Ansible YAML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "parameters.yaml": 9.0.0_vs_10.0.0.

    1 # variables in header
    2 
    3 client_id:
    4   type: string
    5   in: header
    6   description: |
    7     The identification for each client instance. The format of client id is
    8     UUID by default, but Zaqar also supports a Non-UUID string by setting
    9     configuration "client_id_uuid_safe=off". The UUID must be submitted in its
   10     canonical form (for example, 3381af92-2b9e-11e3-b191-71861300734c). The
   11     string must be longer than "min_length_client_id=20" and smaller than
   12     "max_length_client_id=300" by default. User can control the length of
   13     client id by using those two options. The client generates the Client-ID
   14     once. Client-ID persists between restarts of the client so the client
   15     should reuse that same Client-ID. Note: All message-related operations
   16     require the use of ``Client-ID`` in the headers to ensure that messages
   17     are not echoed back to the client that posted them, unless the client
   18     explicitly requests this.
   19 
   20 # variables in path
   21 
   22 claim_id:
   23   type: string
   24   in: path
   25   required: True
   26   description: |
   27     The id of the claim.
   28 
   29 flavor_name_path:
   30   type: string
   31   in: path
   32   required: True
   33   description:
   34     The name of the flavor.
   35 
   36 message_id:
   37   type: string
   38   in: path
   39   required: True
   40   description: |
   41     The ID of the message.
   42 
   43 pool_name_path:
   44   type: string
   45   in: path
   46   required: True
   47   description:
   48     The name of the pool.
   49 
   50 queue_name:
   51   type: string
   52   in: path
   53   required: True
   54   description: |
   55     The name of the queue.
   56 
   57 subscription_id_path:
   58   type: string
   59   in: path
   60   required: True
   61   description: |
   62     The id of the subscription.
   63 
   64 # variables in query
   65 
   66 claim_limit:
   67   type: integer
   68   in: query
   69   required: false
   70   description: |
   71     The ``limit`` specifies up to 20 messages (configurable) to claim. If not
   72     specified, limit defaults to 10. Note that claim creation is best-effort,
   73     meaning the server may claim and return less than the requested number of
   74     messages.
   75 
   76 detailed:
   77   type: boolean
   78   in: query
   79   required: false
   80   description: |
   81     The 'detailed' specifies if showing the detailed information when querying
   82     queues, flavors and pools.
   83 
   84 echo:
   85    type: boolean
   86    in: query
   87    required: false
   88    description:
   89      Indicate if the messages can be echoed back to the client that posted
   90      them.
   91 
   92 ids:
   93   type: list
   94   in: query
   95   required: false
   96   description: |
   97     A list of the messages ids. ``pop`` & ``ids`` parameters are mutually
   98     exclusive. Using them together in a request will result in HTTP 400.
   99 
  100     NOTE: Actually, it's not a real list, it's string combined with many
  101     message ids separated with comma, for example:
  102     /messages?ids=578f0055508f153f256f717e,578f0055508f153f256f717f
  103 
  104 include_claimed:
  105    type: boolean
  106    in: query
  107    required: false
  108    description:
  109      Indicate if the messages list should include the claimed messages.
  110 
  111 include_delayed:
  112    type: boolean
  113    in: query
  114    required: false
  115    description:
  116      Indicate if the messages list should include the delayed messages.
  117 
  118 limit:
  119   type: integer
  120   in: query
  121   required: false
  122   description: |
  123     Requests a page size of items. Returns a number of items up to a limit
  124     value. Use the ``limit`` parameter to make an initial limited request and
  125     use the ID of the last-seen item from the response as the ``marker``
  126     parameter value in a subsequent limited request.
  127 
  128 marker:
  129   type: string
  130   in: query
  131   required: false
  132   description: |
  133     The ID of the last-seen item. Use the ``limit`` parameter to make an
  134     initial limited request and use the ID of the last-seen item from the
  135     response as the ``marker`` parameter value in a subsequent limited request.
  136 
  137 name:
  138   type: string
  139   in: query
  140   required: false
  141   description: |
  142     The 'name' specifies if filter the queues by queue's name when querying
  143     queues.
  144 
  145 pop:
  146   type: integer
  147   in: query
  148   required: false
  149   description: |
  150     The ``pop`` specifies how many messages will be popped up from the queue.
  151     ``pop`` & ``ids`` parameters are mutually exclusive. Using them together
  152     in a request will result in HTTP 400.
  153 
  154 with_count:
  155   type: boolean
  156   in: query
  157   required: false
  158   description: |
  159     The 'with_count' specifies if showing the amount of queues when querying
  160     them.
  161 
  162 # variables in body
  163 
  164 _dead_letter_queue:
  165   type: string
  166   in: body
  167   required: False
  168   description: |
  169     The target the message will be moved to when the message can't processed
  170     successfully after meet the max claim count. It's not supported to add
  171     queue C as the dead letter queue for queue B where queue B has been set
  172     as a dead letter queue for queue A. There is no default value for this
  173     attribute. If it's not set explicitly, then that means there is no dead
  174     letter queue for current queue. It is one of the ``reserved attributes``
  175     of Zaqar queues.
  176 
  177 _dead_letter_queue_messages_ttl:
  178   type: integer
  179   in: body
  180   required: False
  181   description: |
  182     The new TTL setting for messages when moved to dead letter queue. If it's
  183     not set, current TTL will be kept. It is one of the ``reserved attributes``
  184     of Zaqar queues.
  185 
  186 _dead_letter_queue_messages_ttl_response:
  187   type: integer
  188   in: body
  189   required: True
  190   description: |
  191     The new TTL setting for messages when moved to dead letter queue. If it's
  192     not set, current TTL will be kept. It is one of the ``reserved attributes``
  193     of Zaqar queues.
  194 
  195 _dead_letter_queue_response:
  196   type: string
  197   in: body
  198   required: True
  199   description: |
  200     The target the message will be moved to when the message can't processed
  201     successfully after meet the max claim count. It's not supported to add
  202     queue C as the dead letter queue for queue B where queue B has been set
  203     as a dead letter queue for queue A. There is no default value for this
  204     attribute. If it's not set explicitly, then that means there is no dead
  205     letter queue for current queue. It is one of the ``reserved attributes``
  206 
  207 _default_message_delay:
  208   type: string
  209   in: body
  210   required: False
  211   description: |
  212     The delay of messages defined for a queue. When the messages send to
  213     the queue, it will be delayed for some times and means it can not be
  214     claimed until the delay expired. And user can define a queue's level
  215     value for delay, also can define a message's level. The latter has
  216     a higher priority. It is one of the ``reserved attributes`` of Zaqar
  217     queues.
  218 
  219 _default_message_delay_response:
  220   type: string
  221   in: body
  222   required: True
  223   description: |
  224     The delay of messages defined for a queue. When the messages send to
  225     the queue, it will be delayed for some times and means it can not be
  226     claimed until the delay expired. And user can define a queue's level
  227     value for delay, also can define a message's level. The latter has
  228     a higher priority. It is one of the ``reserved attributes`` of Zaqar
  229 
  230 _default_message_ttl:
  231   type: integer
  232   in: body
  233   required: True
  234   description: |
  235     The default TTL of messages defined for a queue, which will effect for
  236     any messages posted to the queue. So when there is no TTL defined for a
  237     message, the queue's _default_message_ttl will be used. By default, the
  238     value is the same value defined as ''max_message_ttl'' in zaqar.conf. It is
  239     one of the ``reserved attributes`` of Zaqar queues. The value will be
  240     reverted to the default value after deleting it explicitly.
  241 
  242 _flavor:
  243   type: string
  244   in: body
  245   required: False
  246   description: |
  247     The flavor name which can tell Zaqar which storage pool will be used to
  248     create the queue. It is one of the ``reserved attributes`` of Zaqar
  249     queues.
  250 
  251 _max_claim_count:
  252   type: integer
  253   in: body
  254   required: False
  255   description: |
  256     The max number the message can be claimed. Generally,
  257     it means the message cannot be processed successfully. There is no default
  258     value for this attribute. If it's not set, then that means this feature
  259     won't be enabled for current queue. It is one of the
  260     ``reserved attributes`` of Zaqar queues.
  261 
  262 _max_claim_count_response:
  263   type: integer
  264   in: body
  265   required: True
  266   description: |
  267     The max number the message can be claimed. Generally,
  268     it means the message cannot be processed successfully. There is no default
  269     value for this attribute. If it's not set, then that means this feature
  270     won't be enabled for current queue. It is one of the
  271     ``reserved attributes`` of Zaqar queues.
  272 
  273 _max_messages_post_size:
  274   type: integer
  275   in: body
  276   required: True
  277   description: |
  278     The max post size of messages defined for a queue, which will effect for
  279     any messages posted to the queue. So user can define a queue's level
  280     cap for post size which can't bigger than the max_messages_post_size
  281     defined in zaqar.conf. It is one of the ``reserved attributes`` of Zaqar
  282     queues. The value will be reverted to the default value after deleting it
  283     explicitly.
  284 
  285 capabilities:
  286   type: list
  287   in: body
  288   description: |
  289     Capabilities describe what this flavor is capable of base on the storage
  290     capabilities. They are used to inform the final user such capabilities.
  291 
  292 catalog_reachable:
  293   type: boolean
  294   in: body
  295   required: True
  296   description: |
  297     A boolean value to indicate if the management(catalog) datatabse is
  298     reachable or not.
  299 
  300 claim_grace:
  301   type: integer
  302   in: body
  303   required: false
  304   description: |
  305     The ``grace`` attribute specifies the message grace period in seconds. The
  306     value of ``grace`` value must be between 60 and 43200 seconds (12 hours).
  307     You must include a value for this attribute in your request. To deal with
  308     workers that have stopped responding (for up to 1209600 seconds or 14 days,
  309     including claim lifetime), the server extends the lifetime of claimed
  310     messages to be at least as long as the lifetime of the claim itself, plus
  311     the specified grace period. If a claimed message would normally live longer
  312     than the claim's live period, its expiration is not adjusted.
  313 
  314 claim_ttl:
  315   type: integer
  316   in: body
  317   required: false
  318   description: |
  319     The ``ttl`` attribute specifies how long the server waits before releasing
  320     the claim. The ttl value must be between 60 and 43200 seconds (12 hours).
  321     You must include a value for this attribute in your request.
  322 
  323 count:
  324   type: integer
  325   in: body
  326   required: false
  327   description: |
  328     The ``count`` attribute specifies how many queus in current project.
  329 
  330 flavor_href:
  331   type: string
  332   in: body
  333   description: |
  334     The url of the flavor.
  335 
  336 flavor_links:
  337   type: array
  338   in: body
  339   required: true
  340   description: |
  341     Links related to the flavors. This is a list of dictionaries, each including
  342     keys ``href`` and ``rel``.
  343 
  344 flavor_name:
  345   type: string
  346   in: body
  347   required: true
  348   description: |
  349     The name of the flavor.
  350 
  351 flavor_pool_group:
  352   type: string
  353   in: body
  354   required: true
  355   description: |
  356     The ``pool_group`` attribute specifies the name of the pool group
  357     this flavor sits on top of.
  358     NOTE: Remove pool_group in Rocky release and use pool_list instead
  359     for flavor.
  360 
  361 flavor_pool_list:
  362   type: list
  363   in: body
  364   description: |
  365     A list of pools in the flavor.
  366     NOTE: Suggest config pool_list in stead of pool_group from the
  367     beginning of Queens.
  368 
  369 flavors:
  370   type: list
  371   in: body
  372   description: |
  373     A list of the flaovrs.
  374 
  375 links:
  376   type: array
  377   in: body
  378   required: true
  379   description: |
  380     Links related to the queues. This is a list of dictionaries, each including
  381     keys ``href`` and ``rel``.
  382 
  383 messages:
  384   type: list
  385   in: body
  386   required: True
  387   description: |
  388     A list of the messages.
  389 
  390 messages_resources:
  391   type: list
  392   in: body
  393   description: |
  394     A list of the URL to messages.
  395 
  396 operation_status:
  397   type: dict
  398   in: body
  399   required: False
  400   description: |
  401     A dict which will contain the status for many different actions/operations.
  402     For example, post_messages, delete_messages, delete queue, etc. And each
  403     status is a dict which contains three items: ``seconds``, ``ref`` and
  404     ``succeeded``. Seconds means how long the operation took and succeeded will
  405     indicate if the actions was successful or not. Ref may contain the
  406     information if the succeeded is False, otherwise it's null.
  407 
  408 pool_flavor:
  409   type: string
  410   in: body
  411   required: false
  412   description: |
  413     The ``flavor`` attribute specifies a tag to given to more than one pool
  414     so that it keeps user remind the purpose/capabilities of all pools that
  415     falls under that flavor.
  416     NOTE: Suggest config flavor in stead of group from the beginning of queen.
  417 
  418 pool_group:
  419   type: string
  420   in: body
  421   required: false
  422   description: |
  423     The ``group`` attribute specifies a tag to given to more than one pool
  424     so that it keeps user remind the purpose/capabilities of all pools that
  425     falls under that group.
  426     NOTE: Remove group in Rocky release and use flavor instead for pool.
  427 
  428 pool_href:
  429   type: string
  430   in: body
  431   description: |
  432     The url of the pool.
  433 
  434 pool_links:
  435   type: array
  436   in: body
  437   required: true
  438   description: |
  439     Links related to the pools. This is a list of dictionaries, each including
  440     keys ``href`` and ``rel``.
  441 
  442 pool_name:
  443   type: string
  444   in: body
  445   description: |
  446     The name of the pool.
  447 
  448 pool_options:
  449   type: dict
  450   in: body
  451   required: false
  452   description: |
  453     The ``options`` attribute gives storage-specific options used by storage
  454     driver implementations. The value must be a dict and valid key-value come
  455     from the registered options for a given storage backend.
  456 
  457 pool_uri:
  458   type: string
  459   in: body
  460   required: true
  461   description: |
  462     The ``uri`` attribute specifies a connection string compatible with a
  463     storage client (e.g., pymongo) attempting to connect to that pool.
  464 
  465 pool_weight:
  466   type: integer
  467   in: body
  468   required: true
  469   description: |
  470     The ``weight`` attribute specifies the likelihood that this pool will be
  471     selected for the next queue allocation. The value must be an integer
  472     greater than -1.
  473 
  474 pools:
  475   type: list
  476   in: body
  477   description: |
  478     A list of the pools.
  479 
  480 pre_signed_queue_expires:
  481   type: string
  482   in: body
  483   required: False
  484   description: |
  485     The time to indicate when the pre-signed will be expired.
  486 
  487 pre_signed_queue_methods:
  488   type: list
  489   in: body
  490   required: False
  491   description: |
  492     A list of HTTP methods. The HTTP method(s) this URL was created for. By
  493     selecting the HTTP method, it's possible to give either read or read/write
  494     access to a specific resource.
  495 
  496 pre_signed_queue_paths:
  497   type: list
  498   in: body
  499   required: False
  500   description: |
  501     A list of paths the pre-signed queue can support. It could be a set of
  502     ``messages``, ``subscriptions``, ``claims``.
  503 
  504 pre_signed_queue_signature:
  505   type: list
  506   in: body
  507   required: True
  508   description: |
  509     The signature is generated after create the pre-signed URL. It can be
  510     consumed by adding below to HTTP headers:
  511 
  512     URL-Signature: 6a63d63242ebd18c3518871dda6fdcb6273db2672c599bf985469241e9a1c799
  513     URL-Expires: 2015-05-31T19:00:17Z
  514 
  515 project_id:
  516   type: string
  517   in: body
  518   required: True
  519   description: |
  520     The ID of current project/tenant.
  521 
  522 queue_metadata:
  523   type: dict
  524   in: body
  525   description: |
  526     Metadata of queue.
  527 
  528 queues:
  529   type: list
  530   in: body
  531   required: true
  532   description: |
  533     A list of the queues.
  534 
  535 resource_types:
  536   type: list
  537   in: body
  538   required: false
  539   description: |
  540     The ``resource_types`` attribute allows user to purge particular resource
  541     of the queue.
  542 
  543 storage_reachable:
  544   type: boolean
  545   in: body
  546   required: False
  547   description: |
  548     A boolean value to indicate if the messages(pool) datatabse is
  549     reachable or not.
  550 
  551 subscriber:
  552   type: string
  553   in: body
  554   required: True
  555   description: |
  556     The ``subscriber`` attribute specifies the destination where the message
  557     notify to. It has been designed to match the Internet RFC on Relative
  558     Uniform Resource Locators. Zaqar now support two kinds of subscribers:
  559     http/https and email. The http/https subscriber should start with
  560     ``http/https``. The email subscriber should start with ``mailto``.
  561 
  562 subscription_age:
  563   type: integer
  564   in: body
  565   description: |
  566     How long the subscription has be existed.
  567 
  568 subscription_id:
  569   type: string
  570   in: body
  571   description: |
  572     The id of the subscription.
  573 
  574 subscription_options:
  575   type: dict
  576   in: body
  577   required: false
  578   description: |
  579     The ``options`` attribute specifies the extra metadata for the subscription
  580     . The value must be a dict and could contain any key-value. If the
  581     subscriber is "mailto". The ``options`` can contain ``from`` and
  582     ``subject`` to indicate the email's author and title.
  583 
  584 subscription_source:
  585   type: string
  586   in: body
  587   description: |
  588     The queue name which the subscription is registered on.
  589 
  590 subscription_ttl:
  591   type: integer
  592   in: body
  593   required: false
  594   description: |
  595     The ``ttl`` attribute specifies how long the subscription be alive. The ttl
  596     value must be great than 60 seconds. The default value is 3600 seconds.
  597 
  598 subscriptions:
  599   type: list
  600   in: body
  601   description: |
  602     A list of the subscriptions.
  603 
  604 versions:
  605   type: list
  606   in: body
  607   required: True
  608   description: |
  609     A list of supported major API versions.