Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 1.23 KB

FormatsApi.md

File metadata and controls

62 lines (40 loc) · 1.23 KB

Phrase::FormatsApi

All URIs are relative to https://api.phrase.com/v2

Method HTTP request Description
formats_list GET /formats List formats

formats_list

Array<Format> formats_list

List formats

Get a handy list of all localization file formats supported in Phrase.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::FormatsApi.new

begin
  #List formats
  result = api_instance.formats_list
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling FormatsApi->formats_list: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Response<(Array<Format>)>

Authorization

Basic, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json