Skip to content

fix(spec): cleanup summary #451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Apr 29, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions specs/abtesting/paths/abtest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ get:
Returns metadata and metrics for A/B test id.

Behaves in the same way as GET /2/abtests however the endpoint will return 403.
summary: Returns metadata and metrics for A/B test id.
summary: Returns metadata and metrics for A/B test id
parameters:
- $ref: '../common/parameters.yml#/ID'
responses:
Expand All @@ -26,7 +26,7 @@ get:
delete:
operationId: deleteABTest
description: Deletes the A/B Test and removes all associated metadata & metrics.
summary: Deletes the A/B Test.
summary: Deletes the A/B Test
parameters:
- $ref: '../common/parameters.yml#/ID'
responses:
Expand Down
4 changes: 2 additions & 2 deletions specs/abtesting/paths/abtests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
Creates a new A/B test with provided configuration.

You can set an A/B test on two different indices with different settings, or on the same index with different search parameters by providing a customSearchParameters setting on one of the variants.
summary: Creates a new A/B test with provided configuration.
summary: Creates a new A/B test with provided configuration
requestBody:
required: true
content:
Expand Down Expand Up @@ -49,7 +49,7 @@ get:
operationId: listABTests
description: >
Fetch all existing A/B tests for App that are available for the current API Key. Returns an array of metadata and metrics. When no data has been processed, the metrics will be returned as null.
summary: Fetch all existing A/B tests for App that are available for the current API Key.
summary: Fetch all existing A/B tests for App that are available for the current API Key
parameters:
- $ref: '../../common/parameters.yml#/Offset'
- $ref: '../../common/parameters.yml#/Limit'
Expand Down
2 changes: 1 addition & 1 deletion specs/abtesting/paths/stopABTest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ post:
At this point, the test is over and cannot be restarted.
As a result, your application is back to normal: index A will perform as usual, receiving 100% of all search requests.
Associated metadata and metrics are still stored.
summary: Marks the A/B test as stopped.
summary: Marks the A/B test as stopped
parameters:
- $ref: '../common/parameters.yml#/ID'
responses:
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/click/getAverageClickPosition.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getAverageClickPosition
description: Returns the average click position. The endpoint returns a value for the complete given time range, as well as a value per day.
summary: Returns the average click position.
summary: Returns the average click position
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/click/getClickPositions.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getClickPositions
description: Returns the distribution of clicks per range of positions.
summary: Returns the distribution of clicks per range of positions.
summary: Returns the distribution of clicks per range of positions
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/click/getClickThroughRate.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getClickThroughRate
description: Returns a click-through rate (CTR). The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of clicks and searches used to compute the rates.
summary: Returns a click-through rate (CTR).
summary: Returns a click-through rate (CTR)
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/click/getConversionRate.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getConversationRate
description: Returns a conversion rate (CR). The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of conversion and searches used to compute the rates.
summary: Returns a conversion rate (CR).
summary: Returns a conversion rate (CR)
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/search/getNoClickRate.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getNoClickRate
description: Returns the rate at which searches didn't lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks.
summary: Returns the rate at which searches didn't lead to any clicks.
summary: Returns the rate at which searches didn't lead to any clicks
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/search/getNoResultsRate.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getNoResultsRate
description: Returns the rate at which searches didn't return any results. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without results used to compute the rates.
summary: Returns the rate at which searches didn't return any results.
summary: Returns the rate at which searches didn't return any results
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/search/getSearchesCount.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getSearchesCount
description: Returns the number of searches across the given time range. The endpoint returns a value for the complete given time range, as well as a value per day.
summary: Returns the number of searches across the given time range.
summary: Returns the number of searches across the given time range
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/search/getSearchesNoClicks.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getSearchesNoClicks
description: Returns top searches that didn't lead to any clicks. Limited to the 1000 most frequent ones. For each search, also returns the average number of found hits.
summary: Returns top searches that didn't lead to any clicks.
summary: Returns top searches that didn't lead to any clicks
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/search/getSearchesNoResults.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getSearchesNoResults
description: Returns top searches that didn't return any results. Limited to the 1000 most frequent ones.
summary: Returns top searches that didn't return any results.
summary: Returns top searches that didn't return any results
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/search/getTopCountries.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getTopCountries
description: Returns top countries. Limited to the 1000 most frequent ones.
summary: Returns top countries.
summary: Returns top countries
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/search/getTopFilterAttributes.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getTopFilterAttributes
description: Returns top filter attributes. Limited to the 1000 most used filters.
summary: Returns top filter attributes.
summary: Returns top filter attributes
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../common/parameters.yml#/Search'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/search/getTopFilterForAttribute.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getTopFilterForAttribute
description: Returns top filters for the given attribute. Limited to the 1000 most used filters.
summary: Returns top filters for the given attribute.
summary: Returns top filters for the given attribute
parameters:
- $ref: '../../common/parameters.yml#/Attribute'
- $ref: '../../../common/parameters.yml#/Index'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/search/getTopFiltersNoResults.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getTopFiltersNoResults
description: Returns top filters with no results. Limited to the 1000 most used filters.
summary: Returns top filters with no results.
summary: Returns top filters with no results
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../common/parameters.yml#/Search'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/search/getTopHits.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getTopHits
description: Returns top hits. Limited to the 1000 most frequent ones.
summary: Returns top hits.
summary: Returns top hits
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../common/parameters.yml#/Search'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/search/getTopSearches.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getTopSearches
description: Returns top searches. Limited to the 1000 most frequent ones. For each search, also returns the average number of hits returned.
summary: Returns top searches.
summary: Returns top searches
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../common/parameters.yml#/ClickAnalytics'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/search/getUsersCount.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getUsersCount
description: Returns the distinct count of users across the given time range. The endpoint returns a value for the complete given time range, as well as a value per day.
summary: Returns the distinct count of users across the given time range.
summary: Returns the distinct count of users across the given time range
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/status/getStatus.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getStatus
description: Returns the latest update time of the analytics API for a given index. If the index has been recently created and/or no search has been performed yet the updated time will be null.
summary: Get latest update time of the analytics API.
summary: Get latest update time of the analytics API
parameters:
- $ref: '../../../common/parameters.yml#/Index'
responses:
Expand Down
2 changes: 1 addition & 1 deletion specs/common/schemas/CustomRequest.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
customRequest:
summary: Send requests to the Algolia REST API.
summary: Send requests to the Algolia REST API
description: This method allow you to send requests to the Algolia REST API.
parameters:
- $ref: '#/PathInPath'
Expand Down
2 changes: 1 addition & 1 deletion specs/insights/paths/pushEvents.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
post:
operationId: pushEvents
description: This command pushes an array of events.
summary: Pushes an array of events.
summary: Pushes an array of events
requestBody:
required: true
content:
Expand Down
2 changes: 1 addition & 1 deletion specs/personalization/paths/deleteUserProfile.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
delete:
operationId: deleteUserProfile
description: Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means that if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile. It might take a couple hours before for the deletion request to be fully processed.
summary: Delete the user profile and all its associated data.
summary: Delete the user profile and all its associated data
parameters:
- $ref: '../common/parameters.yml#/UserToken'
responses:
Expand Down
2 changes: 1 addition & 1 deletion specs/personalization/paths/getUserTokenProfile.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getUserTokenProfile
description: The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.
summary: Get the user profile built from Personalization strategy.
summary: Get the user profile built from Personalization strategy
parameters:
- $ref: '../common/parameters.yml#/UserToken'
responses:
Expand Down
4 changes: 2 additions & 2 deletions specs/personalization/paths/personalizationStrategy.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
post:
operationId: setPersonalizationStrategy
description: A strategy defines the events and facets that impact user profiles and personalized search results.
summary: Set a new personalization strategy.
summary: Set a new personalization strategy
requestBody:
required: true
content:
Expand Down Expand Up @@ -34,7 +34,7 @@ post:
get:
operationId: getPersonalizationStrategy
description: The strategy contains information on the events and facets that impact user profiles and personalized search results.
summary: Get the current personalization strategy.
summary: Get the current personalization strategy
responses:
'200':
description: OK
Expand Down
2 changes: 1 addition & 1 deletion specs/predict/paths/fetchUserProfile.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
post:
operationId: fetchUserProfile
description: Get predictions, properties (raw, computed or custom) and segments (computed or custom) for a user profile.
summary: Get user profile.
summary: Get user profile
parameters:
- $ref: '../common/parameters.yml#/userID'
requestBody:
Expand Down
2 changes: 1 addition & 1 deletion specs/query-suggestions/paths/getConfigurationStatus.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ get:
Get the status of a Query Suggestion's index.

The status includes whether the Query Suggestions index is currently in the process of being built, and the last build time.
summary: Get the status of a Query Suggestion's index.
summary: Get the status of a Query Suggestion's index
parameters:
- $ref: '../../common/parameters.yml#/IndexName'
responses:
Expand Down
2 changes: 1 addition & 1 deletion specs/query-suggestions/paths/getLogFile.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
operationId: getLogFile
description: Get the log file of the last build of a single Query Suggestion index.
summary: Get the log file of the last build of a single Query Suggestion index.
summary: Get the log file of the last build of a single Query Suggestion index
parameters:
- $ref: '../../common/parameters.yml#/IndexName'
responses:
Expand Down
6 changes: 3 additions & 3 deletions specs/query-suggestions/paths/qsConfig.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
put:
operationId: updateConfig
description: Update the configuration of a Query Suggestions index.
summary: Update the configuration of a Query Suggestions index.
summary: Update the configuration of a Query Suggestions index
parameters:
- $ref: '../../common/parameters.yml#/IndexName'
requestBody:
Expand All @@ -26,7 +26,7 @@ delete:
By deleting a configuraton, you stop all updates to the underlying query suggestion index.

Note that when doing this, the underlying index does not change - existing suggestions remain untouched.
summary: Delete a configuration of a Query Suggestion's index.
summary: Delete a configuration of a Query Suggestion's index
parameters:
- $ref: '../../common/parameters.yml#/IndexName'
responses:
Expand All @@ -42,7 +42,7 @@ delete:
get:
operationId: getConfig
description: Get the configuration of a single Query Suggestions index.
summary: Get the configuration of a single Query Suggestions index.
summary: Get the configuration of a single Query Suggestions index
parameters:
- $ref: '../../common/parameters.yml#/IndexName'
responses:
Expand Down
4 changes: 2 additions & 2 deletions specs/query-suggestions/paths/qsConfigs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
post:
operationId: createConfig
description: Create a configuration of a Query Suggestions index. There's a limit of 100 configurations per application.
summary: Create a configuration of a Query Suggestions index.
summary: Create a configuration of a Query Suggestions index
requestBody:
required: true
content:
Expand All @@ -28,7 +28,7 @@ get:
Get all the configurations of Query Suggestions.

For each index, you get a block of JSON with a list of its configuration settings.
summary: Get all the configurations of Query Suggestions.
summary: Get all the configurations of Query Suggestions
responses:
'200':
description: OK
Expand Down
2 changes: 1 addition & 1 deletion specs/recommend/paths/getRecommendations.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
post:
operationId: getRecommendations
description: Returns recommendations for a specific model and objectID.
summary: Returns recommendations for a specific model and objectID.
summary: Returns recommendations for a specific model and objectID
requestBody:
required: true
content:
Expand Down
4 changes: 2 additions & 2 deletions specs/search/paths/advanced/getLogs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ get:
tags:
- Advanced
operationId: getLogs
description: Return the lastest log entries.
summary: Return the lastest log entries.
description: Return the latest log entries.
summary: Return the latest log entries
parameters:
- name: offset
in: query
Expand Down
2 changes: 1 addition & 1 deletion specs/search/paths/advanced/getTask.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ get:
- Indices
operationId: getTask
description: Check the current status of a given task.
summary: Check the current status of a given task.
summary: Check the status of a task
parameters:
- $ref: '../../../common/parameters.yml#/IndexName'
- name: taskID
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ post:
- Dictionnaries
operationId: batchDictionaryEntries
description: Send a batch of dictionary entries.
summary: Send a batch of dictionary entries.
summary: Batch dictionary entries
parameters:
- $ref: 'common/parameters.yml#/DictionaryName'
requestBody:
Expand Down
6 changes: 3 additions & 3 deletions specs/search/paths/dictionaries/dictionarySettings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ get:
- Dictionnaries
operationId: getDictionarySettings
description: Retrieve dictionaries settings. The API stores languages whose standard entries are disabled. Fetch settings does not return false values.
summary: Retrieve dictionaries settings.
summary: Retrieve dictionaries settings
responses:
'200':
description: OK
Expand Down Expand Up @@ -31,8 +31,8 @@ put:
tags:
- Dictionnaries
operationId: setDictionarySettings
description: Set dictionary settings.
summary: Set dictionary settings.
description: Set dictionaries settings.
summary: Set dictionaries settings
requestBody:
required: true
content:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ get:
- Dictionnaries
operationId: getDictionaryLanguages
description: List dictionaries supported per language.
summary: List dictionaries supported per language.
summary: List available languages
responses:
'200':
description: OK
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ post:
- Dictionnaries
operationId: searchDictionaryEntries
description: Search the dictionary entries.
summary: Search the dictionary entries.
summary: Search a dictionary entries
parameters:
- $ref: 'common/parameters.yml#/DictionaryName'
requestBody:
Expand Down
Loading