All URIs are relative to https://api.phrase.com/v2
| Method | HTTP request | Description |
|---|---|---|
| StyleguideCreate | Post /projects/{project_id}/styleguides | Create a style guide |
| StyleguideDelete | Delete /projects/{project_id}/styleguides/{id} | Delete a style guide |
| StyleguideShow | Get /projects/{project_id}/styleguides/{id} | Get a single style guide |
| StyleguideUpdate | Patch /projects/{project_id}/styleguides/{id} | Update a style guide |
| StyleguidesList | Get /projects/{project_id}/styleguides | List style guides |
StyleguideDetails StyleguideCreate(ctx, projectId, styleguideCreateParameters, optional)
Create a style guide
Create a new style guide.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| styleguideCreateParameters | StyleguideCreateParameters | ||
| optional | *StyleguideCreateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a StyleguideCreateOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
StyleguideDelete(ctx, projectId, id, optional)
Delete a style guide
Delete an existing style guide.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| id | string | ID | |
| optional | *StyleguideDeleteOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a StyleguideDeleteOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
StyleguideDetails StyleguideShow(ctx, projectId, id, optional)
Get a single style guide
Get details on a single style guide.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| id | string | ID | |
| optional | *StyleguideShowOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a StyleguideShowOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
StyleguideDetails StyleguideUpdate(ctx, projectId, id, styleguideUpdateParameters, optional)
Update a style guide
Update an existing style guide.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| id | string | ID | |
| styleguideUpdateParameters | StyleguideUpdateParameters | ||
| optional | *StyleguideUpdateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a StyleguideUpdateOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Styleguide StyleguidesList(ctx, projectId, optional)
List style guides
List all styleguides for the given project.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| optional | *StyleguidesListOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a StyleguidesListOpts 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 |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]