Skip to content

Headers used by Sword

Anusha Ranganathan edited this page Nov 15, 2018 · 2 revisions
  • Content-Type

    • Must when updating the metadata of a fileset
    • Used to determine if file is a metadata file (xml content type)
  • Content-Disposition

    • Must for binary deposits
    • Used to determine original file name of file being submitted
  • Content-MD5

    • Should provide for all deposits
    • When provided, the payload is validated against this md5 sum
  • Packaging

    • Not used.
      I use file mime type to determine this data. The bagit library is used to determine if the provided data is a valid bag.
  • In-Progress

    • When provided, this boolena value is saved in the appropriate metadata field in the model
  • On-Behalf-Of

    • This field should contain the user's login id (email)
    • When provided, the user is fetched and used as the depositor
  • Slug

    • used for create
    • When provided, the object is created using this identifier
  • Hyrax-Work-Model

    • When used, the name of the class loaded before performing work requests is read from this field and the class is instantiated
  • Api-key

    • MUST if sword requests need to be authenticated
    • When used all sword requests are authorized only if the api-key matches to a user record
    • This user is used when creating datasets to set the depositor
Clone this wiki locally