Skip to content

Latest commit

 

History

History
55 lines (32 loc) · 1.92 KB

KeyFormatAnnotationsApi.md

File metadata and controls

55 lines (32 loc) · 1.92 KB

phrase.KeyFormatAnnotationsApi

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

Method HTTP request Description
KeyFormatAnnotationsList Get /projects/{project_id}/keys/{id}/format_annotations List format annotations for a key

KeyFormatAnnotationsList

[]KeyFormatAnnotationsList200ResponseInner KeyFormatAnnotationsList(ctx, projectId, id, optional)

List format annotations for a key

Returns the format annotations stored on a translation key. Format annotations capture file-format data recorded when the key was imported — for example, an ARB placeholder block or an XLIFF note. Results are limited to 1,000 entries.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string Project ID
id string ID
optional *KeyFormatAnnotationsListOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a KeyFormatAnnotationsListOpts struct

Name Type Description Notes
xPhraseAppOTP optional.String Two-Factor-Authentication token (optional)
branch optional.String Branch to use

Return type

[]KeyFormatAnnotationsList200ResponseInner

Authorization

Basic, Token

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]