Skip to content
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.

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

Support 'notes' field on create/update operations #54

Closed
5 of 8 tasks
maniax89 opened this issue Jan 6, 2017 · 6 comments
Closed
5 of 8 tasks

Support 'notes' field on create/update operations #54

maniax89 opened this issue Jan 6, 2017 · 6 comments
Assignees
Milestone

Comments

@maniax89
Copy link

maniax89 commented Jan 6, 2017

According to the swagger spec, the field notes is supported on get/create/update for a few places:

Would be great if we could have access to this notes field across these endpoints

@srl295 srl295 self-assigned this Jan 6, 2017
@srl295 srl295 added this to the v1.4.0 milestone Jan 6, 2017
@srl295
Copy link
Contributor

srl295 commented Mar 3, 2017

@yumaoka are notes part of bundle/getResourceStrings / bundle/uploadResourceStrings / bundle/updateResourceStrings ?

srl295 added a commit that referenced this issue Mar 3, 2017
* bundle: support in create/update/getInfo
* resourceEntry: support in update/getInfo
* make some setters more future-proof

Remaining:  Not sure if uploadStrings or updateStrings also has notes support.

#54
@srl295
Copy link
Contributor

srl295 commented Mar 3, 2017

@maniax89 i opened a PR above ^ that supports all of the 'explicit' modes of notes fields.

@yumaoka
Copy link

yumaoka commented Mar 3, 2017

@srl295

@yumaoka are notes part of bundle/getResourceStrings / bundle/uploadResourceStrings / bundle/updateResourceStrings ?

Yes.

Also, resource entry APIs: getResourceEntryInfo / updateResourceEntryInfo.
And, bundle APIs (for bundle wide notes) : getBundleInfo / createBundle / updateBundle.

@srl295
Copy link
Contributor

srl295 commented Mar 3, 2017

@yumaoka

Yes

Thanks, I will look into this and add them.

Also, resource entry APIs: getResourceEntryInfo / updateResourceEntryInfo. And, bundle APIs (for bundle wide notes) : getBundleInfo / createBundle / updateBundle

Got that… already supported in this PR.

@srl295
Copy link
Contributor

srl295 commented Mar 22, 2017

(for reference)

for bundle/uploadResourceStrings this body: payload works:

{
  "key": {
      "value": "value",
     "notes": [ "abc","def"]
   }
}

and similarly for bundle/updateResourceStrings:

{
   "key":  {
     "value": "value2",
    "notes":  [ "ghi", "jkl" ]
  }
}

and when the resourceEntries field is passed to bundle/getResourceStrings the full resource data is returned.

The g11n-pipeline package doesn't currently do anything to enable, but doesn't prevent, this kind of access. I think I'd like to punt on this for now pending some additional design… however, I will add these test cases to the test to show how it can be used now.

@maniax89 any thoughts?

@srl295
Copy link
Contributor

srl295 commented Mar 22, 2017

Landed above support in c2893ab, will work on the bulk operations in #65 (next release)

@srl295 srl295 closed this as completed Mar 22, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants