Make REST help translatable; fix a few missing translations

This commit is contained in:
Jyri-Petteri Paloposki 2021-08-31 01:06:42 +03:00
parent 8cbe476599
commit a4a6f50ad5
4 changed files with 129 additions and 55 deletions

View file

@ -9,6 +9,7 @@ en:
due_style: Due style
first_name: First name
last_name: Last name
email: Email
locale: Locale
mobile_todos_per_page: Actions per page (Mobile View)
refresh: Refresh interval (in minutes)
@ -1333,3 +1334,57 @@ en:
zero: No %{model} found
page_gap: "…"
previous_label: "← Previous"
auth_type:
database: Database
rest_help:
title: REST API Documentation for Developers
id: ID
curl_link_text: cURL
intro:
title: Introduction
content: Tracks is designed to be integrated with scripts, web services, and third-party applications. This page serves as the documentation of our REST API.
content_2: The Tracks REST API allows developers to integrate Tracks into their applications. It allows applications to access and modify Tracks data, and is implemented as Vanilla XML over HTTP.
content_3: The API is a %{restful_link} service. All data is available through the API as a resource to which can be referred using a unique identifier. It responds to a number of the HTTP methods, specifically GET, PUT, POST and UPDATE, and all responses from the API are in a simple XML format encoded as UTF-8.
restful_link_text: RESTful
auth:
title: Authentication
content: Authentication is handled using %{auth_link}. Your Tracks username and password is used as the authentication credentials for the API. Note that in Basic HTTP authentication, your password is sent in clear text. If you need a more secure authentication solution, you should configure your web server to run Tracks under HTTPS.
basic_auth_link_text: Basic HTTP authentication
retrieve:
title: Retrieving data from the API
content: 'To retrieve data you only need to do an HTTP GET on a resource identifier. For example, if you want to get all the contexts with %{curl_link}:'
single_context: 'Getting a single context:'
todos_from_context: 'Getting the todos within a context:'
projects: You also can apply the pattern shown above with projects instead of contexts.
paths_title: 'All data is available according to the following resource paths:'
limit: 'For the todo resources (todos, tickler, done, hidden and calendar) you can limit the returnedfield to %{fields} by adding the parameter %{limit_parameter} and setting it to %{set_to}. For example:'
active_todos: 'If you only want to get the active todos, you add the parameter %{active_code} and set it to some value like this:'
writing:
title: Writing to the API
description: The API provides mechanisms for adding, updating and deleting resources using the HTTP methods %{put}, %{post} and %{delete} in combination with the content.
example_title: 'Creating a new project, using curl:'
example_project_name: Build a treehouse for the kids
example_project_response_title: 'The response is an %{response_code} with %{header} header indicating where the new project resource can be found. Now we can add a todo to this project, using curl:'
example_todo_name: Model treehouse in SketchUp
example_todo_response_title: 'The response is a again an %{response_code} with %{header} header indicating where the new todo resource can be found. Changing the todo notes, again using curl:'
example_note_text: use maple texture
example_note_response_title: 'The response is an %{response_code} with in the body the XML representation of the updated todo. We provide a shorcut method to toggle a todo done or undone without having to perform the update with the right field values:'
example_delete_title: 'If we want to delete that todo we can call its unique resource identifier (the URL) with the HTTP method %{delete}, again with curl:'
example_delete_response_title: The API returns an %{response_code} and the todo is now deleted.
response:
title: Dealing with the response and response status
description: All successful operations respond with a status code of %{response_200} or %{response_201} depending on the operation. Sometimes a list, say %{example_call} will not have any items, it will return an empty list.
xml_description: 'The XML for empty list responses look like this, again with curl:'
activeresource:
title: Consuming the API with ActiveResource
description: '%{activeresource_link} is a thin but powerful wrapper around RESTful services exposed by %{ror_link}. It will be part of Rails 2.0 but until then you can get it with %{gem_command}.'
activeresource_link_text: ActiveResource
ror_link_text: Ruby on Rails
wrapper_description: 'Inspired by %{signals_link} ’s Highrise wrapper, we’ve put together a small ruby wrapper (find it in the doc/ directory) for the API which sets up the ActiveResource models for you to play with in an IRB session:'
signals_link_text: 37 Signals
notes:
title: Notes about the documentation
description: 'A few conventions have been applied in the documentation, these are:'
bullet1: '%{id}’s in a resource %{url} indicate that the resource’s unique ID needs to be inserted there'
bullet2: '%{omit} indicates that unimportant bits of response data have been removed to eliminate noise from the documentation'
curl_description: 'All examples make use of %{curl}.'

View file

@ -9,6 +9,7 @@ fi:
due_style: Määräpäivän esitystapa
first_name: Etunimi
last_name: Sukunimi
email: Sähköpostiosoite
locale: Kieli
mobile_todos_per_page: Toimenpidettä sivulla (mobiilisivustolla)
refresh: Päivitystiheys (minuutteina)
@ -1340,3 +1341,5 @@ fi:
zero: '%{model} ei löytynyt'
page_gap: "…"
previous_label: "← Edellinen"
auth_type:
database: Tietokanta