Skip to content

SMS and Account Self-Service API proofreading (grammar fixes) #107

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.

Sign up for GitHub

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

Open
radekholy24 wants to merge 10 commits into
base: master
Choose a base branch
from
Open

SMS and Account Self-Service API proofreading (grammar fixes) #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
5cdae63
Fix the description of the response 200 to /messaging/v1/sms
radekholy24 Jan 4, 2022
a33b859
Add missing "was" to the description of the SMS Conversion tag
radekholy24 Jan 4, 2022
c8bbdb0
Fix the description of timestamp in the ContactEntity
radekholy24 Jan 4, 2022
072f0c2
Remove extra ResponseEntity from SMS API
radekholy24 Jan 4, 2022
9c27da8
Fix grammar errors and typos found by Grammarly in the SMS API
radekholy24 Jan 12, 2022
2bb76a1
Fix the description of size in GET /byon/phonebook/v1/numbers
radekholy24 Jan 4, 2022
a7f289c
Fix the description of friendlyName in the ContactEntity
radekholy24 Jan 4, 2022
ed03e62
Fix grammar errors and typos in Account IP Restriction API
radekholy24 Jan 17, 2022
c286f35
Fix grammar errors and typos in the descriptions of Problem
radekholy24 Jan 17, 2022
18fbe2c
Fix grammar errors and typos in Account Keys API
radekholy24 Jan 17, 2022
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
14 changes: 7 additions & 7 deletions account/ip-restriction/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ info:
version: "1.0"
title: Account IP Restriction API
description: |
The IP restriction API helps you managing your account and whitelisting your IPs and subnets for higher security when using your tyntec API key.
The IP restriction API helps you with managing your account and whitelisting your IPs and subnets for higher security when using your tyntec API key.

contact:
name: tyntec API Support
Expand Down Expand Up @@ -38,7 +38,7 @@ paths:
- ApiKeyHeader: []
operationId: ipRestrictionPOST
description: |
Modifies the IP whitelisting or this account. The operation is idempotent and will override the list of IPs and ranges that already exist.
Modifies the IP whitelisting for this account. The operation is idempotent and will override the list of IPs and ranges that already exist.
responses:
"200":
description: The IP whitelist as modified by this request.
Expand All @@ -47,7 +47,7 @@ paths:
schema:
$ref: "#/components/schemas/IpRestrictionEntity"
"400":
description: Invalid request
description: An invalid request
content:
application/json:
schema:
Expand All @@ -71,7 +71,7 @@ paths:
schema:
$ref: "#/components/schemas/Problem"
requestBody:
description: IP restriction whitelist
description: An IP restriction whitelist
required: true
content:
application/json:
Expand All @@ -94,7 +94,7 @@ paths:
schema:
$ref: "#/components/schemas/IpRestrictionEntity"
"400":
description: Invalid request
description: An invalid request
content:
application/json:
schema:
Expand Down Expand Up @@ -160,15 +160,15 @@ components:
example: https://docs.tyntec.com/problems/DataNotParseable
type: string
title:
description: Short, human-readable summary of the problem type
description: A short, human-readable summary of the problem type
type: string
example: The given data were not parsable.
status:
description: The HTTP status code (RFC7231, Section 6) generated by the origin server for this occurrence of the problem
type: string
example: 400
detail:
description: Human-readable explanation specific to this problem occurrence
description: A human-readable explanation specific to this problem occurrence
type: string
example: |
Unexpected end-of-input: expected close marker for Object (start marker at [Source: UNKNOWN; line: -1, column: -1) at [Source: UNKNOWN; line: 1, column: 97]
20 changes: 10 additions & 10 deletions account/keys/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ info:
version: "1.0"
title: Account Keys API
description: |
The keys API helps you managing your account API keys. You can add a secondary key for your account and delete the old one. With this mechanism you can safely rotate a key, on runtime, to keep your account safe.
The keys API helps you with managing your account API keys. You can add a secondary key to your account and delete the old one. With this mechanism you can safely rotate a key, on runtime, to keep your account safe.
contact:
name: tyntec API Support
url: http://www.tyntec.com/support
Expand All @@ -17,16 +17,16 @@ security:
tags:
- name: Account keys
description: |
tyntec’s account keys service allow you to:
tyntec’s account keys service allows you to:

- Add a secondary authentication token key on your account. Both keys (old and new) will be valid and active.
- You can delete the old key once your new key is replaced at your systems.
- Add a secondary authentication token key to your account. Both keys (old and new) will be valid and active.
- You can delete the old key once your new key is replaced in your systems.

**Important**

You can not delete the key you are using for this API call.

Once a key is deleted, this will have immediate effect and no recovery is possible.
Once a key is deleted, this will have an immediate effect and no recovery is possible.
paths:
/account/v1/keys:
get:
Expand All @@ -46,7 +46,7 @@ paths:
schema:
$ref: "#/components/schemas/ApiKeyResponse"
"400":
description: Invalid request
description: An invalid request
content:
application/json:
schema:
Expand Down Expand Up @@ -86,7 +86,7 @@ paths:
schema:
$ref: "#/components/schemas/ApiKeyResponse"
"400":
description: Invalid request
description: An invalid request
content:
application/json:
schema:
Expand Down Expand Up @@ -138,7 +138,7 @@ paths:
schema:
$ref: "#/components/schemas/ApiKeyResponse"
"400":
description: Invalid request
description: An invalid request
content:
application/json:
schema:
Expand Down Expand Up @@ -210,15 +210,15 @@ components:
example: https://docs.tyntec.com/problems/DataNotParseable
type: string
title:
description: Short, human-readable summary of the problem type
description: A short, human-readable summary of the problem type
type: string
example: The given data were not parsable.
status:
description: The HTTP status code (RFC7231, Section 6) generated by the origin server for this occurrence of the problem
type: string
example: 400
detail:
description: Human-readable explanation specific to this problem occurrence
description: A human-readable explanation specific to this problem occurrence
type: string
example: |
Unexpected end-of-input: expected close marker for Object (start marker at [Source: UNKNOWN; line: -1, column: -1) at [Source: UNKNOWN; line: 1, column: 97]
Loading