Skip to content

Latest commit

 

History

History
204 lines (117 loc) · 5.65 KB

TagsApi.md

File metadata and controls

204 lines (117 loc) · 5.65 KB

\TagsApi

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

Method HTTP request Description
TagCreate Post /projects/{project_id}/tags Create a tag
TagDelete Delete /projects/{project_id}/tags/{name} Delete a tag
TagShow Get /projects/{project_id}/tags/{name} Get a single tag
TagsList Get /projects/{project_id}/tags List tags

TagCreate

TagWithStats TagCreate(ctx, projectId, tagCreateParameters, optional)

Create a tag

Create a new tag.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a TagCreateOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |

Return type

TagWithStats

Authorization

Basic, Token

HTTP request headers

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

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

TagDelete

TagDelete(ctx, projectId, name, optional)

Delete a tag

Delete an existing tag.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a TagDeleteOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | branch | optional.String| specify the branch to use |

Return type

(empty response body)

Authorization

Basic, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

TagShow

TagWithStats TagShow(ctx, projectId, name, optional)

Get a single tag

Get details and progress information on a single tag for a given project.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a TagShowOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | branch | optional.String| specify the branch to use |

Return type

TagWithStats

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]

TagsList

[]Tag TagsList(ctx, projectId, optional)

List tags

List all tags for the given project.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a TagsListOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | page | optional.Int32| Page number | perPage | optional.Int32| Limit on the number of objects to be returned, between 1 and 100. 25 by default | excludeSystemTags | optional.Bool| excludes tags generated by the system, e.g. job, upload or figma tags | branch | optional.String| specify the branch to use |

Return type

[]Tag

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]