Rework the account/settings endpoint #44

Dorthu · 2018-01-12T18:42:42Z

This is a proposal for how the new endpoints will look. Please review
and comment here so I can implement.

yoshizzle · 2018-01-18T14:56:36Z

src/data/endpoints/account.yaml

+        examples:
+          curl: |
+            curl -h "Content-Type: application/json" \
+                -h "Authorization: Bearer $TOKEn" \


capital N in TOKEN, please

yoshizzle · 2018-01-18T14:58:46Z

src/data/objects/account.yaml

    type: String
-    description: This account's company name.
-    value: My Company LLC
+    description: State (or province) portion of this account's billing address.


Might be helpful to explain in detail that if the customer is not in the US, please enter the province here. I know you have (or province) in parens, but I know from experience dealing with a lot of Asian folks - for example - that it's not entirely clear.

That one Thai customer account from two months ago comes to mind as well.

I guess I'm saying, let's add a little more detail in the description to be 100% perfectly clear.

yoshizzle · 2018-01-18T14:59:27Z

src/data/objects/account.yaml

@@ -16,10 +27,14 @@ schema:
    type: String
    description: City portion of this account's billing address.


do we need to say "portion"? Seems weird. Maybe:

The City for this account's billing address.

yoshizzle · 2018-01-18T14:59:43Z

src/data/objects/account.yaml

+    value: PA
+  zip:
+    type: String
+    description: Zip Code portion of this account's billing address.


The Zip Code for this account's billing address.

yoshizzle · 2018-01-18T15:00:21Z

src/data/endpoints/account.yaml

-            curl -H "Content-Type: application/json" \
-                -H "Authorization: Bearer $TOKEN" \
+            curl -h "content-type: application/json" \
+                -h "authorization: bearer $token" \


Authorization
Bearer
$TOKEN

yoshizzle · 2018-01-18T15:01:26Z

src/data/endpoints/account.yaml

+            curl -h "Content-Type: application/json" \
+                -h "Authorization: Bearer $TOKEn" \
+                -X PUT -d '{
+                  "network_helper": true,
                  "longview_subscription": "longview-10"


So there is nothing else to edit in account/settings now?

If there is, please add them. If not, then, uh... cool!

with this proposal, there is not

yoshizzle · 2018-01-18T15:09:43Z

src/data/objects/account.yaml

-    description: This account's company name.
-    value: My Company LLC
+    description: >
+      State portion of this account's billing address, or providence if you


province, not providence

why you hating on Rhode Island?

This is still not fixed

RobertDeRose · 2018-01-18T15:10:11Z

src/data/endpoints/account.yaml

      PUT:
        description: >
          Edits your account settings.
        examples:
          curl: |
-            curl -H "Content-Type: application/json" \
-                -H "Authorization: Bearer $TOKEN" \
+            curl -h "Content-Type: application/json" \


why did these get changed to -h from -H when the man for curl says -H is correct?

😞 I think I hit u instead of y one time and didn't notice

RobertDeRose · 2018-01-18T15:13:09Z

src/data/endpoints/account.yaml

+          Returns your current defaults.
+        examples:
+          curl: |
+            curl -h "Authorization: Bearer $TOKEN" \


-H here too

RobertDeRose · 2018-01-18T15:13:27Z

src/data/endpoints/account.yaml

+          Edits your account's defaults.
+        examples:
+          curl: |
+            curl -h "Content-Type: application/json" \


-H here as well

yoshizzle · 2018-01-18T19:22:42Z

src/data/objects/account.yaml

-    description: This account's company name.
-    value: My Company LLC
+    description: >
+      State portion of this account's billing address, or providence if you


This is still not fixed

RobertDeRose · 2018-01-19T17:47:56Z

src/data/objects/account.yaml

 schema:
+  first_name:


Missing PUT output

RobertDeRose · 2018-01-19T17:48:19Z

src/data/endpoints/account.yaml

+      Manage default settings for your account.
+    methods:
+      GET:
+        response: account_settings


Should probably include something like is_managed

This is a proposal for how the new endpoints will look. Please review and comment here so I can implement.

Quick fix to description of label validation for creating a Linode

Added capitalization to titles and headers

Release to master

Dorthu added the iteration label Jan 16, 2018

yoshizzle changed the title ~~[ DO NOT MERGE ] Rework the account/settings endpoint~~ Rework the account/settings endpoint Jan 17, 2018

yoshizzle requested changes Jan 18, 2018

View reviewed changes

RobertDeRose reviewed Jan 18, 2018

View reviewed changes

RobertDeRose suggested changes Jan 18, 2018

View reviewed changes

Dorthu force-pushed the feature/rework-account-endpoint branch from 455a118 to 424f83d Compare January 18, 2018 19:20

yoshizzle requested changes Jan 18, 2018

View reviewed changes

Dorthu force-pushed the feature/rework-account-endpoint branch from 424f83d to e26a571 Compare January 19, 2018 16:06

yoshizzle approved these changes Jan 19, 2018

View reviewed changes

RobertDeRose reviewed Jan 19, 2018

View reviewed changes

src/data/objects/account.yaml

schema:

first_name:

Copy link

Contributor

RobertDeRose Jan 19, 2018

Choose a reason for hiding this comment

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

Missing PUT output

RobertDeRose suggested changes Jan 19, 2018

View reviewed changes

Dorthu added 3 commits January 22, 2018 13:55

brk: Rework the account/settings endpoint

afa21b8

This is a proposal for how the new endpoints will look. Please review and comment here so I can implement.

Addressed PR feedback

019639b

Adds missing "managed" field

1f96f27

Dorthu force-pushed the feature/rework-account-endpoint branch from 007de1e to 1f96f27 Compare January 22, 2018 18:55

RobertDeRose approved these changes Jan 22, 2018

View reviewed changes

Dorthu merged commit 695987a into linode:develop Jan 22, 2018

asauber mentioned this pull request Jan 23, 2018

Use separate /account and account/settings endpoints linode/manager#2928

Merged

alioso pushed a commit that referenced this pull request Aug 22, 2019

Merge pull request #44 from jsager/dashes

5ec2a08

Quick fix to description of label validation for creating a Linode

LBGarber pushed a commit to LBGarber/linode-api-docs that referenced this pull request Jun 15, 2022

Merge pull request linode#44 from jsager/capitals

d5264c9

Added capitalization to titles and headers

LBGarber pushed a commit to LBGarber/linode-api-docs that referenced this pull request Jun 15, 2022

Merge pull request linode#44 from linode/development

872f7fb

Release to master

		@@ -16,10 +27,14 @@ schema:
		type: String
		description: City portion of this account's billing address.

Rework the account/settings endpoint #44

Rework the account/settings endpoint #44

Uh oh!

Conversation

Dorthu commented Jan 12, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!