Uploaded image for project: 'FTS'
  1. FTS
  2. FTS-1735

FTS-REST clients should set "User-Agent" header

    XMLWordPrintable

Details

    • New Feature
    • Status: Closed
    • Medium
    • Resolution: Fixed
    • fts-rest-server 3.12.0, fts-rest 3.11.0
    • fts-rest 3.11.1
    • FTS-Flask, REST API
    • Security Level: Public Data (This ticket is visible to anyone on the internet and will be indexed by search engines)
    • None

    Description

      With the on-going effort to release FTS-REST-Flask and decommission the old FTS-REST (Pylons) implementation, the need arises to distinguish clients.

      This will be useful in tracking how many clients are on the old/new client, as well as providing backwards compatibility server-side.

      Proposal
      FTS-REST clients should set the User-Agent header with the client version.
      An additional field should be provided to request compatibility with the Pylons implementation.

      Example

      User-Agent: fts-rest-client/3.11.0
      

      The compatibility flag will let the FTS-REST-Flask server know whether the response should be backwards compatible.

      Since we can't distinguish between the old FTS-Rest clients and other usages (e.g.: curl), the differentiation should be based on the client version.
      Example: version >= 3.12.0 benefits from the new behavior, the rest go via the backwards compatible behavior

      Update
      An extra requirement was raised. To distinguish requests coming from the CLI or the python binding clients, the requests should also set the User-Agent header with the origin of the request.

      Examples
      A request coming from the CLI:

      User-Agent: fts-rest-cli/3.11.0
      

      A request coming from the python bindings:

      User-Agent: fts-python-bindings/3.11.0
      

      Attachments

        Activity

          People

            batistal Joao Pedro Lopes
            mipatras Mihai Patrascoiu
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: