Deploying from phrase/openapi@4b4f1acf

phrase · Feb 1, 2024 · 8293dd0 · 8293dd0
1 parent 3cab095
commit 8293dd0
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -244,7 +244,7 @@ Class | Method | HTTP request | Description
 *ProjectsApi* | [**ProjectShow**](docs/ProjectsApi.md#projectshow) | **Get** /projects/{id} | Get a single project
 *ProjectsApi* | [**ProjectUpdate**](docs/ProjectsApi.md#projectupdate) | **Patch** /projects/{id} | Update a project
 *ProjectsApi* | [**ProjectsList**](docs/ProjectsApi.md#projectslist) | **Get** /projects | List projects
-*QualityPerformanceScoreApi* | [**ProjectsQualityPerformanceScore**](docs/QualityPerformanceScoreApi.md#projectsqualityperformancescore) | **Post** /projects/{id}/quality_performance_score | Get project&#39;s translations&#39; quality performance scores
+*QualityPerformanceScoreApi* | [**ProjectsQualityPerformanceScore**](docs/QualityPerformanceScoreApi.md#projectsqualityperformancescore) | **Post** /projects/{project_id}/quality_performance_score | Get Translation Quality
 *ReleasesApi* | [**ReleaseCreate**](docs/ReleasesApi.md#releasecreate) | **Post** /accounts/{account_id}/distributions/{distribution_id}/releases | Create a release
 *ReleasesApi* | [**ReleaseDelete**](docs/ReleasesApi.md#releasedelete) | **Delete** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Delete a release
 *ReleasesApi* | [**ReleasePublish**](docs/ReleasesApi.md#releasepublish) | **Post** /accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publish | Publish a release

diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -21349,9 +21349,10 @@ paths:
           --data '{"branch":"my-feature-branch"}' \
           --access_token <token>
       x-cli-version: "2.5"
-  /projects/{id}/quality_performance_score:
+  /projects/{project_id}/quality_performance_score:
     post:
-      description: Get project's translations' quality performance scores
+      description: "Retrieves the quality scores for your Strings translations. Returns\
+        \ a score, measured by Phrase QPS"
       operationId: projects/quality_performance_score
       parameters:
       - description: Two-Factor-Authentication token (optional)
@@ -21362,10 +21363,10 @@ paths:
         schema:
           type: string
         style: simple
-      - description: ID
+      - description: Project ID
         explode: false
         in: path
-        name: id
+        name: project_id
         required: true
         schema:
           type: string
@@ -21434,21 +21435,21 @@ paths:
               $ref: '#/components/headers/X-Rate-Limit-Reset'
         "504":
           description: Gateway timeout
-      summary: Get project's translations' quality performance scores
+      summary: Get Translation Quality
       tags:
       - Quality performance score
       x-code-samples:
       - lang: Curl
         source: |-
-          curl "https://api.phrase.com/v2/projects/:id/quality_performance_score" \
+          curl "https://api.phrase.com/v2/projects/:project_id/quality_performance_score" \
             -X POST \
             -u USERNAME_OR_ACCESS_TOKEN \
             -d '{"translation_ids":["translation_id_1", "translation_id_2"]}' \
             -H 'Content-Type: application/json'
       - lang: CLI v2
         source: |-
           phrase projects quality_performance_score \
-          --id <id> \
+          --project_id <project_id> \
           --data '{"translation_ids":["translation_id_1", "translation_id_2"]}' \
           --access_token <token>
       x-cli-version: "2.20"
@@ -32838,7 +32839,7 @@ components:
         data:
           $ref: '#/components/schemas/projects_quality_performance_score_200_response_anyOf_data'
         errors:
-          description: Array of errors for any failing translation ids
+          description: Array of errors for any failing translation IDs
           items:
             $ref: '#/components/schemas/projects_quality_performance_score_200_response_anyOf_errors_inner'
           type: array

diff --git a/api_quality_performance_score.go b/api_quality_performance_score.go
@@ -24,17 +24,17 @@ type ProjectsQualityPerformanceScoreOpts struct {
 }
 
 /*
-ProjectsQualityPerformanceScore Get project's translations' quality performance scores
-Get project&#39;s translations&#39; quality performance scores
+ProjectsQualityPerformanceScore Get Translation Quality
+Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS
   - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
-  - @param id ID
+  - @param projectId Project ID
   - @param projectsQualityPerformanceScoreRequest
   - @param optional nil or *ProjectsQualityPerformanceScoreOpts - Optional Parameters:
   - @param "XPhraseAppOTP" (optional.String) -  Two-Factor-Authentication token (optional)
 
 @return ProjectsQualityPerformanceScore200Response
 */
-func (a *QualityPerformanceScoreApiService) ProjectsQualityPerformanceScore(ctx _context.Context, id string, projectsQualityPerformanceScoreRequest ProjectsQualityPerformanceScoreRequest, localVarOptionals *ProjectsQualityPerformanceScoreOpts) (ProjectsQualityPerformanceScore200Response, *APIResponse, error) {
+func (a *QualityPerformanceScoreApiService) ProjectsQualityPerformanceScore(ctx _context.Context, projectId string, projectsQualityPerformanceScoreRequest ProjectsQualityPerformanceScoreRequest, localVarOptionals *ProjectsQualityPerformanceScoreOpts) (ProjectsQualityPerformanceScore200Response, *APIResponse, error) {
 	var (
 		localVarHTTPMethod   = _nethttp.MethodPost
 		localVarPostBody     interface{}
@@ -45,8 +45,8 @@ func (a *QualityPerformanceScoreApiService) ProjectsQualityPerformanceScore(ctx
 	)
 
 	// create path and map variables
-	localVarPath := a.client.cfg.BasePath + "/projects/{id}/quality_performance_score"
-	localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", _neturl.QueryEscape(parameterToString(id, "")), -1)
+	localVarPath := a.client.cfg.BasePath + "/projects/{project_id}/quality_performance_score"
+	localVarPath = strings.Replace(localVarPath, "{"+"project_id"+"}", _neturl.QueryEscape(parameterToString(projectId, "")), -1)
 
 	localVarHeaderParams := make(map[string]string)
 	localVarQueryParams := _neturl.Values{}

diff --git a/docs/ProjectsQualityPerformanceScore200Response.md b/docs/ProjectsQualityPerformanceScore200Response.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Error** | [**ErrorError**](ErrorError.md) |  | [optional] 
 **Data** | [**ProjectsQualityPerformanceScore200ResponseAnyOfData**](ProjectsQualityPerformanceScore200ResponseAnyOfData.md) |  | [optional] 
-**Errors** | [**[]ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation ids | [optional] 
+**Errors** | [**[]ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation IDs | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md b/docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md
@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Data** | [**ProjectsQualityPerformanceScore200ResponseAnyOfData**](ProjectsQualityPerformanceScore200ResponseAnyOfData.md) |  | [optional] 
-**Errors** | [**[]ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation ids | [optional] 
+**Errors** | [**[]ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation IDs | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/QualityPerformanceScoreApi.md b/docs/QualityPerformanceScoreApi.md
@@ -4,25 +4,25 @@ All URIs are relative to *https://api.phrase.com/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**ProjectsQualityPerformanceScore**](QualityPerformanceScoreApi.md#ProjectsQualityPerformanceScore) | **Post** /projects/{id}/quality_performance_score | Get project&#39;s translations&#39; quality performance scores
+[**ProjectsQualityPerformanceScore**](QualityPerformanceScoreApi.md#ProjectsQualityPerformanceScore) | **Post** /projects/{project_id}/quality_performance_score | Get Translation Quality
 
 
 
 ## ProjectsQualityPerformanceScore
 
-> ProjectsQualityPerformanceScore200Response ProjectsQualityPerformanceScore(ctx, id, projectsQualityPerformanceScoreRequest, optional)
+> ProjectsQualityPerformanceScore200Response ProjectsQualityPerformanceScore(ctx, projectId, projectsQualityPerformanceScoreRequest, optional)
 
-Get project's translations' quality performance scores
+Get Translation Quality
 
-Get project's translations' quality performance scores
+Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS
 
 ### Required Parameters
 
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
-**id** | **string**| ID | 
+**projectId** | **string**| Project ID | 
 **projectsQualityPerformanceScoreRequest** | [**ProjectsQualityPerformanceScoreRequest**](ProjectsQualityPerformanceScoreRequest.md)|  | 
  **optional** | ***ProjectsQualityPerformanceScoreOpts** | optional parameters | nil if no parameters
 

diff --git a/model_projects_quality_performance_score_200_response.go b/model_projects_quality_performance_score_200_response.go
@@ -4,6 +4,6 @@ package phrase
 type ProjectsQualityPerformanceScore200Response struct {
 	Error ErrorError                                          `json:"error,omitempty"`
 	Data  ProjectsQualityPerformanceScore200ResponseAnyOfData `json:"data,omitempty"`
-	// Array of errors for any failing translation ids
+	// Array of errors for any failing translation IDs
 	Errors []ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner `json:"errors,omitempty"`
 }
diff --git a/model_projects_quality_performance_score_200_response_any_of.go b/model_projects_quality_performance_score_200_response_any_of.go
@@ -3,6 +3,6 @@ package phrase
 // ProjectsQualityPerformanceScore200ResponseAnyOf struct for ProjectsQualityPerformanceScore200ResponseAnyOf
 type ProjectsQualityPerformanceScore200ResponseAnyOf struct {
 	Data ProjectsQualityPerformanceScore200ResponseAnyOfData `json:"data,omitempty"`
-	// Array of errors for any failing translation ids
+	// Array of errors for any failing translation IDs
 	Errors []ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner `json:"errors,omitempty"`
 }