u/pc/rhodecode-enterprise-ce-fork-pc Files · docs/api/methods/license-methods.rst

http-proto: in case incoming requests come in as chunked stream the data to VCSServer....

http-proto: in case incoming requests come in as chunked stream the data to VCSServer. This should solve a problem of uploading large files to rhodecode. In case of git with small postBuffers GIT client streams data to the server. In such case we want to stream the data back again to vcsserver without reading it fully inside RhodeCode.

marcink - - Load All Authors

File last commit:

r1120:d4155363 default


                r1434:59cf3775

stable

Download file

             license-methods.rst
        
                    71 lines
            
             | 1.5 KiB
            
                | text/x-rst
            
             |
                RstLexer
            
             / docs / api / methods / license-methods.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        dan
    
docs: update api docs

              r618
            
      .. _license-methods-ref:

      license methods

        marcink
    
docs: regenerated api docs with new fixed automation script....

              r989
            
      ===============

        dan
    
docs: update api docs

              r618
            
      get_license_info (EE only)

        marcink
    
docs: fixed small wanrings/errors during build.

              r1120
            
      --------------------------

        dan
    
docs: update api docs

              r618
            
      .. py:function:: get_license_info(apiuser)

         Returns the |RCE| license information.

         :param apiuser: This is filled automatically from the |authtoken|.

         :type apiuser: AuthUser

         Example output:

         .. code-block:: bash

           id : <id_given_in_input>

           result : {

             'rhodecode_version': <rhodecode version>,

             'token': <license token>,

             'issued_to': <license owner>,

             'issued_on': <license issue date>,

             'expires_on': <license expiration date>,

             'type': <license type>,

             'users_limit': <license users limit>,

             'key': <license key>

           }

           error :  null

      set_license_key (EE only)

        marcink
    
docs: fixed small wanrings/errors during build.

              r1120
            
      -------------------------

        dan
    
docs: update api docs

              r618
            
      .. py:function:: set_license_key(apiuser, key)

         Sets the |RCE| license key.

         :param apiuser: This is filled automatically from the |authtoken|.

         :type apiuser: AuthUser

         :param key: This is the license key to be set.

         :type key: str

         Example output:

         .. code-block:: bash

             id : <id_given_in_input>

             result: {

                       "msg" : "updated license information",

                       "key": <key>

                     }

             error:  null

         Example error output:

         .. code-block:: bash

           id : <id_given_in_input>

           result : null

           error :  {

             "license key is not valid"

             or

             "trial licenses cannot be uploaded"

             or

             "error occurred while updating license"

           }

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

dan docs: update api docs	r618	.. _license-methods-ref:

		license methods
marcink docs: regenerated api docs with new fixed automation script....	r989	===============
dan docs: update api docs	r618
		get_license_info (EE only)
marcink docs: fixed small wanrings/errors during build.	r1120	--------------------------
dan docs: update api docs	r618
		.. py:function:: get_license_info(apiuser)

		Returns the \|RCE\| license information.

		:param apiuser: This is filled automatically from the \|authtoken\|.
		:type apiuser: AuthUser

		Example output:

		.. code-block:: bash

		id : <id_given_in_input>
		result : {
		'rhodecode_version': <rhodecode version>,
		'token': <license token>,
		'issued_to': <license owner>,
		'issued_on': <license issue date>,
		'expires_on': <license expiration date>,
		'type': <license type>,
		'users_limit': <license users limit>,
		'key': <license key>
		}
		error : null


		set_license_key (EE only)
marcink docs: fixed small wanrings/errors during build.	r1120	-------------------------
dan docs: update api docs	r618
		.. py:function:: set_license_key(apiuser, key)

		Sets the \|RCE\| license key.

		:param apiuser: This is filled automatically from the \|authtoken\|.
		:type apiuser: AuthUser
		:param key: This is the license key to be set.
		:type key: str

		Example output:

		.. code-block:: bash

		id : <id_given_in_input>
		result: {
		"msg" : "updated license information",
		"key": <key>
		}
		error: null

		Example error output:

		.. code-block:: bash

		id : <id_given_in_input>
		result : null
		error : {
		"license key is not valid"
		or
		"trial licenses cannot be uploaded"
		or
		"error occurred while updating license"
		}