Re: [jira] [Commented] (TC-28) API response structure should be hierarchical instead of flat

[David Neuman]

API 1.3!!!

On Fri, Nov 4, 2016 at 3:41 PM, Jeremy Mitchell 
wrote:

> what i should have done has rolled api/1.3
>
> on monday, i'll get api/1.2 back to where it's always been and move this
> new structure into api/1.3
>
> Jeremy
>
> On Fri, Nov 4, 2016 at 3:11 PM, ASF GitHub Bot (JIRA) 
> wrote:
>
> >
> > [ https://issues.apache.org/jira/browse/TC-28?page=com.
> > atlassian.jira.plugin.system.issuetabpanels:comment-
> > tabpanel=15637694#comment-15637694 ]
> >
> > ASF GitHub Bot commented on TC-28:
> > --
> >
> > Github user mitchell852 closed the pull request at:
> >
> > https://github.com/apache/incubator-trafficcontrol/pull/48
> >
> >
> > > API response structure should be hierarchical instead of flat
> > > -
> > >
> > > Key: TC-28
> > > URL: https://issues.apache.org/jira/browse/TC-28
> > > Project: Traffic Control
> > >  Issue Type: Improvement
> > >  Components: Traffic Ops API
> > >Affects Versions: 1.8.0
> > >Reporter: Jeremy Mitchell
> > >Priority: Minor
> > > Fix For: 1.8.0
> > >
> > >
> > > I created a handful of api endpoints in 1.8 with a flat response
> > structure like:
> > > {
> > > "response": [
> > > {
> > > "asn": "23",
> > > "cachegroupId": "69",
> > > "cachegroupName": "Foo_Cachegroup",
> > > "id": "60",
> > > "lastUpdated": "2016-10-13 12:31:43"
> > > }
> > > ]
> > > }
> > > Although this is fine, it makes it more difficult to test when using
> > structures derived from the database. This structure is more friendly.
> > > {
> > > "response": [
> > > {
> > > "asn": "23",
> > > "cachegroup": {
> > > "id": "69",
> > > "name": "Aberdeen_17802B_Ciscos"
> > > },
> > > "id": "60",
> > > "lastUpdated": "2016-10-13 12:31:43"
> > > }
> > > ]
> > > }
> > > This nested structure needs to be applied to api endpoints related to
> > asn, cachegroup, deliveryservice, phys_location, region, server and user.
> >
> >
> >
> > --
> > This message was sent by Atlassian JIRA
> > (v6.3.4#6332)
> >
>

Re: [jira] [Commented] (TC-28) API response structure should be hierarchical instead of flat

[Jeremy Mitchell]

what i should have done has rolled api/1.3

on monday, i'll get api/1.2 back to where it's always been and move this
new structure into api/1.3

Jeremy

On Fri, Nov 4, 2016 at 3:11 PM, ASF GitHub Bot (JIRA) 
wrote:

>
> [ https://issues.apache.org/jira/browse/TC-28?page=com.
> atlassian.jira.plugin.system.issuetabpanels:comment-
> tabpanel=15637694#comment-15637694 ]
>
> ASF GitHub Bot commented on TC-28:
> --
>
> Github user mitchell852 closed the pull request at:
>
> https://github.com/apache/incubator-trafficcontrol/pull/48
>
>
> > API response structure should be hierarchical instead of flat
> > -
> >
> > Key: TC-28
> > URL: https://issues.apache.org/jira/browse/TC-28
> > Project: Traffic Control
> >  Issue Type: Improvement
> >  Components: Traffic Ops API
> >Affects Versions: 1.8.0
> >Reporter: Jeremy Mitchell
> >Priority: Minor
> > Fix For: 1.8.0
> >
> >
> > I created a handful of api endpoints in 1.8 with a flat response
> structure like:
> > {
> > "response": [
> > {
> > "asn": "23",
> > "cachegroupId": "69",
> > "cachegroupName": "Foo_Cachegroup",
> > "id": "60",
> > "lastUpdated": "2016-10-13 12:31:43"
> > }
> > ]
> > }
> > Although this is fine, it makes it more difficult to test when using
> structures derived from the database. This structure is more friendly.
> > {
> > "response": [
> > {
> > "asn": "23",
> > "cachegroup": {
> > "id": "69",
> > "name": "Aberdeen_17802B_Ciscos"
> > },
> > "id": "60",
> > "lastUpdated": "2016-10-13 12:31:43"
> > }
> > ]
> > }
> > This nested structure needs to be applied to api endpoints related to
> asn, cachegroup, deliveryservice, phys_location, region, server and user.
>
>
>
> --
> This message was sent by Atlassian JIRA
> (v6.3.4#6332)
>