Skip to content

added rates_table.public_notes #238

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
LeonidMorozov wants to merge 1 commit into
base: master
Choose a base branch
from
Open

added rates_table.public_notes #238

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions content/reference/endpoints/rates_tables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Name | Type | Read/Write | Description
id | Integer | Read | Rates Table's id.
-----------------|---------|-------------------------
name | String | Read | Rates Table's name.
public_notes | Text | Read | Rates Table's public notes.
shared | Boolean | Read | Rates Table's shared status.
-----------------|---------|-------------------------
created_at | [Time](/reference/enums#formats) | Read | Rate's create time.
Expand All @@ -28,6 +29,7 @@ Name | Type | Read/Write | Description
id | Integer | Read | Rates Table's id.
-----------------|---------|-------------------------
name | String | Read/Write | **Required**. Rates Table's name. (50 characters max)
public_notes | Text | Read | Rates Table's public notes.
Copy link
Contributor

@StoneFrog StoneFrog Dec 21, 2017

Choose a reason for hiding this comment

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

I think we should use JSON types only, right? So String rather than Text

Copy link
Contributor Author

@LeonidMorozov LeonidMorozov Feb 22, 2018

Choose a reason for hiding this comment

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

@StoneFrog , I see Type = Text on other entities as well. Are you sure we should use String ?

Copy link
Contributor

@thilonel thilonel Feb 22, 2018

Choose a reason for hiding this comment

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

I'd keep text, it's obvious that text is longer than string, but we can add a section about what our types mean in the doc if you think this needs clarification.

Copy link
Contributor Author

@LeonidMorozov LeonidMorozov Feb 22, 2018

Choose a reason for hiding this comment

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

@Azdaroth , WDYT?

Copy link
Member

@Azdaroth Azdaroth Feb 23, 2018

Choose a reason for hiding this comment

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

"String" would be more correct, but I think "Text" is more practical, same as Integer vs. Biginteger.

Copy link
Contributor

@StoneFrog StoneFrog Feb 23, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

I'm ok with keeping text but good to explain it. We already have formats section explaining time, decimal and so on.

shared | Boolean | Read | Rates Table's shared status. (Rates Table is made shared when creating or updating through api)
-----------------|---------|-------------------------
created_at | [Time](/reference/enums#formats) | Read | Rate's create time.
Expand Down