Skip to content

SMS and Account Self-Service API proofreading#104

Open
radekholy24 wants to merge 24 commits into
tyntec:masterfrom
radekholy24:proofreading-sms
Open

SMS and Account Self-Service API proofreading#104
radekholy24 wants to merge 24 commits into
tyntec:masterfrom
radekholy24:proofreading-sms

Conversation

@radekholy24

@radekholy24 radekholy24 commented Dec 21, 2021

Copy link
Copy Markdown
Contributor

I have been assigned a task to proofread the API Reference. Alex has suggested to me to create a pull request for all my findings.

Comment thread sms/v1/openapi.yaml
Comment thread sms/v1/openapi.yaml
Comment thread sms/v1/openapi.yaml Outdated
@radekholy24 radekholy24 changed the title SMS API proofreading SMS and Account Self-Service API proofreading Jan 3, 2022
Comment thread sms/v1/openapi.yaml
Comment thread sms/v1/openapi.yaml
Comment thread sms/v1/openapi.yaml
Comment thread sms/v1/openapi.yaml
Comment thread sms/v1/openapi.yaml Outdated
Comment thread sms/v1/openapi.yaml
Comment thread sms/v1/openapi.yaml
Comment thread sms/v1/openapi.yaml
Comment thread sms/v1/openapi.yaml
Comment thread sms/v1/openapi.yaml Outdated
Comment on lines +1092 to +1091
originMNC:
type: string
type: number

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could not test it. Is this correct?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope according to the code, those values are indeed strings. So the example must have double quotes and the type should remain string

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I've replaced d4629bd with c173ae0.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, sorry, I hadn't changed originMCC. So, I've replaced f69d724 with ed251df too.

Comment thread sms/v1/openapi.yaml
@radekholy24 radekholy24 marked this pull request as ready for review January 3, 2022 16:31
@radekholy24

radekholy24 commented Jan 3, 2022

Copy link
Copy Markdown
Contributor Author

@0xdeadbee, this is now ready to be reviewed. Can you please take a look?

@alextoulps alextoulps left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of reverts needed. Other than that really nice, thanks!

Comment thread sms/v1/openapi.yaml
Comment thread sms/v1/openapi.yaml
Comment thread sms/v1/openapi.yaml
Comment thread sms/v1/openapi.yaml
Comment thread sms/v1/openapi.yaml
Comment thread sms/v1/openapi.yaml
Comment thread sms/v1/openapi.yaml Outdated
Comment on lines +1092 to +1091
originMNC:
type: string
type: number

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope according to the code, those values are indeed strings. So the example must have double quotes and the type should remain string

Comment thread sms/v1/openapi.yaml Outdated
Comment thread sms/v1/openapi.yaml Outdated
Comment thread sms/v1/openapi.yaml
@radekholy24 radekholy24 assigned radekholy24 and unassigned alextoulps Jan 4, 2022
@radekholy24 radekholy24 force-pushed the proofreading-sms branch 3 times, most recently from ccf262c to 1594d0c Compare January 4, 2022 15:21
@radekholy24 radekholy24 requested a review from alextoulps January 4, 2022 15:31
@radekholy24 radekholy24 assigned alextoulps and unassigned radekholy24 Jan 4, 2022
Comment thread sms/v1/openapi.yaml
Comment on lines 562 to 571
post:
tags:
- BYON Contact Service
summary: Create a contact
description: Creates a new contact.
security:
- ApiKeyHeader: []
operationId: createContactUsingPOST
requestBody:
$ref: "#/components/requestBodies/ContactEntity"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@0xdeadbee, one last thing. It confuses me that the request to create a contact requires a comma-separated list but the content type is JSON. Shouldn't that be the text/csv content type?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants