changed the spec issues-api #23
Conversation
spec/swagger.yaml
Outdated
| description: >- | ||
| Currently the only allowed issue states are `OPENED` and `RESOLVED` but | ||
| Smartling may introduce additional states in future. This request | ||
| returns all current allowed states. | ||
| tags: | ||
| - Issues | ||
| - Dictionaries |
There was a problem hiding this comment.
I believe this is how it groups the API's, so it should still be under Issues i believe.
spec/swagger.yaml
Outdated
| in: path | ||
| required: true | ||
| type: string | ||
| description: '' |
There was a problem hiding this comment.
description should be provided
spec/swagger.yaml
Outdated
| in: path | ||
| required: true | ||
| type: string | ||
| description: '' |
There was a problem hiding this comment.
please add description (this applies to all params, fields, etc)
spec/swagger.yaml
Outdated
| @@ -2545,7 +2610,7 @@ paths: | |||
| as needed before attempting to render it. Maximum length is 4000 | |||
| characters. | |||
| tags: | |||
| - Issues | |||
| - Comments | |||
There was a problem hiding this comment.
i believe it should be issues still
There was a problem hiding this comment.
This should be Issues
jones-smartling
requested review from
DmitryBochorishvili,
klee-smartling and
2un
spec/swagger.yaml
Outdated
| get: | ||
| summary: List all issue types | ||
| summary: Get Issue Types (DEPRECATED) | ||
| description: >- | ||
| This request returns all current issue types. Smartling may occasionally |
There was a problem hiding this comment.
since it's deprecated, I think the description should say what should be used instead
| description: >- | ||
| This request returns all current issue types. Smartling may occasionally | ||
| add or change the list of allowed issue types. | ||
| tags: | ||
| - Issues | ||
| deprecated: true |
There was a problem hiding this comment.
didnt know they had this, good to know
|
The tags still need to be changed |
spec/swagger.yaml
Outdated
| description: >- | ||
| Returns a list of issues matching specified filter options. You can | ||
| filter based on the date issues were created, target languages, strings, | ||
| issue types and states and the user who opened the issue. Unless | ||
| otherwise specified, request will return a maximum of 30 results. All | ||
| parameters are optional. | ||
| tags: | ||
| - Issues | ||
| - Search |
spec/swagger.yaml
Outdated
| tags: | ||
| - Issues | ||
| - Watchers |
|
I see the response block is not showing up on the rendered page, that needs to be addressed before its merged |
spec/swagger.yaml
Outdated
| get: | ||
| summary: List all issue types | ||
| summary: Get Issue Types (DEPRECATED) |
There was a problem hiding this comment.
i dont think the first API listed should be a deprecated API. This should be moved to the bottom of the APi's for Issues
| in: query | ||
| required: false | ||
| type: string | ||
| description: Unique identifier of corresponding account |
There was a problem hiding this comment.
The description is off
| required: false | ||
| default: 100 | ||
| type: number | ||
| description: limit |
There was a problem hiding this comment.
@jones-smartling @hchaps, seems like various apis use different description for limit and offset parameters. Do we want them to be consistent across all apis?
There was a problem hiding this comment.
Might need @hchaps to help standardize the language here, but for now its ok. We wont get consistent across defaults and such and that is ok. My 2 cents.
spec/swagger.yaml
Outdated
| @@ -3008,51 +3081,33 @@ paths: | |||
| in: path | |||
| required: true | |||
| type: string | |||
| description: Unique identifier of corresponding account | |||
There was a problem hiding this comment.
extra space before Unique
spec/swagger.yaml
Outdated
| @@ -3065,22 +3120,24 @@ paths: | |||
| in: path | |||
| required: true | |||
| type: string | |||
| description: '' | |||
| description: Unique identifier of corresponding account | |||
There was a problem hiding this comment.
extra space before Unique
spec/swagger.yaml
Outdated
| - name: watcherUid | ||
| in: path | ||
| required: true | ||
| type: string | ||
| description: '' | ||
| description: Unique identifier of corresponding watcher |
There was a problem hiding this comment.
extra space before Unique
spec/swagger.yaml
Outdated
| - name: issueUid | ||
| in: path | ||
| required: true | ||
| type: string | ||
| description: '' | ||
| description: Unique identifier of corresponding issue |
There was a problem hiding this comment.
extra space before Unique
There was a problem hiding this comment.
Done for all places
| data: | ||
| type: object | ||
| properties: |
There was a problem hiding this comment.
Is possible to extract issue and watcher response properties into a separate item and to reuse it wherever needed? Like for get/find/create issues responses?
See
Line 7777 in 8156345
- #23 - wrong reference fix
No description provided.