Skip to content

Latest commit

 

History

History
154 lines (96 loc) · 4.99 KB

SpellCheckApi.md

File metadata and controls

154 lines (96 loc) · 4.99 KB

\SpellCheckApi

All URIs are relative to https://cloud.memsource.com/web

Method HTTP request Description
AddWord Post /api2/v1/spellCheck/words Add word to dictionary
Check Post /api2/v1/spellCheck/check Spell check
CheckByJob Post /api2/v1/spellCheck/check/{jobUid} Spell check for job
Suggest Post /api2/v1/spellCheck/suggest Suggest a word

AddWord

AddWord(ctx, optional) Add word to dictionary

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *SpellCheckApiAddWordOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SpellCheckApiAddWordOpts struct

Name Type Description Notes
body optional.Interface of DictionaryItemDto

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

Check

SpellCheckResponseDto Check(ctx, optional) Spell check

Spell check using the settings of the user's organization

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *SpellCheckApiCheckOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SpellCheckApiCheckOpts struct

Name Type Description Notes
body optional.Interface of SpellCheckRequestDto

Return type

SpellCheckResponseDto

Authorization

No authorization required

HTTP request headers

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

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

CheckByJob

SpellCheckResponseDto CheckByJob(ctx, jobUid, optional) Spell check for job

Spell check using the settings from the project of the job

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
jobUid string
optional *SpellCheckApiCheckByJobOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SpellCheckApiCheckByJobOpts struct

Name Type Description Notes

body | optional.Interface of SpellCheckRequestDto| |

Return type

SpellCheckResponseDto

Authorization

No authorization required

HTTP request headers

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

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

Suggest

SuggestResponseDto Suggest(ctx, optional) Suggest a word

Spell check suggest using the users's spell check dictionary

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *SpellCheckApiSuggestOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SpellCheckApiSuggestOpts struct

Name Type Description Notes
body optional.Interface of SuggestRequestDto

Return type

SuggestResponseDto

Authorization

No authorization required

HTTP request headers

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

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