ngcp-panel

Commit Graph

Author	SHA1	Message	Date
Kirill Solomko	2b144caf2c	TT#128605 implement dynamic fields expand * add API functionality to request additional data and expand fields in GET methods * syntax: - /api/resource/?expand=all - expands all expandable fields e.g.: customer_id field is expanded and customer internally is queried and returned under "customer" => {...} (the returned data is identical to what /api/customers/id would return) - /api/resource/?expand=reseller_id,customer_id - expands only reseller_id and customer_id fields, if they are expandable - /api/resource/?expand=reseller_id,invalidfield_id - returns the data and expands only fields that are expandable (reseller_id in this case) but if it finds either unknown fields or non-expandable fields, changes HTTP status code to "409 Conflict" * adapt all API endpoints to support dynamic expand fields expanding functionality, however the actual expand for them requires modifying the form fields in the following format: has_field 'contact_id' => ( element_attr => { expand => { class => 'NGCP::Panel::Role::API::CustomerContacts', id_field => 'contact_id', alias => 'contact', fetch => 0, }, }, ); - class - represents the class that should be used by the logic to fetch the relevant data - id_field - which field from the resource needs to be expanded, it should be the "id" field (subscriber_id, domain_id, etc.) - alias - (optional), under which key the fetched data is stored. the field name is used as the key if the option is omitted. - fetch - (optional), if the returned data is under $data->{contract_id} then it will be fetched from there and stored under the key (field name or alias), otherwise the whole retreived data is stored under the key (field name or alias) * adapt /api/autoattendants to use the new approach (old one was expand=1) * currently supported endpoints with expand: - admins - autoattendants - domains - customers - customercontacts - resellers - subscribers Change-Id: Iac53409dad944ed4794039a48dc3a9f6dce25bc1	4 years ago
Rene Krenn	fefcaef806	TT#34751 TT#34752 /api/callqueues including: + call_id + start_time + duration + caller (from_uri) + callee (to_uri) Change-Id: I1b0aea9bf578a71fd3e1a5433c9801ebde173b65	7 years ago

Author

SHA1

Message

Date

Kirill Solomko

2b144caf2c

TT#128605 implement dynamic fields expand

* add API functionality to request additional data
  and expand fields in GET methods
* syntax:
   - /api/resource/?expand=all - expands all expandable fields
     e.g.: customer_id field is expanded and customer internally
     is queried and returned under "customer" => {...}
     (the returned data is identical to what /api/customers/id
      would return)
   - /api/resource/?expand=reseller_id,customer_id - expands
     only reseller_id and customer_id fields, if they are expandable
   - /api/resource/?expand=reseller_id,invalidfield_id -
     returns the data and expands only fields that are expandable
     (reseller_id in this case) but if it finds either unknown
     fields or non-expandable fields, changes HTTP status code
     to "409 Conflict"
* adapt all API endpoints to support dynamic expand fields expanding
  functionality, however the actual expand for them requires modifying
  the form fields in the following format:
  has_field 'contact_id' => (
      element_attr => {
        expand => {
            class    => 'NGCP::Panel::Role::API::CustomerContacts',
            id_field => 'contact_id',
            alias    => 'contact',
            fetch    => 0,
        },
    },
  );
  - class - represents the class that should be used by the logic
    to fetch the relevant data
  - id_field - which field from the resource needs to be expanded,
    it should be the "id" field (subscriber_id, domain_id, etc.)
  - alias - (optional), under which key the fetched data is stored.
    the field name is used as the key if the option is omitted.
  - fetch - (optional), if the returned data is under
    $data->{contract_id} then it will be fetched from there and
    stored under the key (field name or alias), otherwise the whole
    retreived data is stored under the key (field name or alias)
* adapt /api/autoattendants to use the new approach (old one was expand=1)
* currently supported endpoints with expand:
  - admins
  - autoattendants
  - domains
  - customers
  - customercontacts
  - resellers
  - subscribers

Change-Id: Iac53409dad944ed4794039a48dc3a9f6dce25bc1

Rene Krenn

fefcaef806

TT#34751 TT#34752 /api/callqueues

including:
+ call_id
+ start_time
+ duration
+ caller (from_uri)
+ callee (to_uri)

Change-Id: I1b0aea9bf578a71fd3e1a5433c9801ebde173b65

2 Commits (03271187c71cd5297d8a9c2f3520074c84d5a582)