Sha256: 07bdd09efac24258f5ab0cbc4c83618c706a93cbf0e441466503f6b0e3847d54

Contents?: true

Size: 963 Bytes

Versions: 15

Compression:

Stored size: 963 Bytes

Contents

<div class="row">
  <div class="col-lg-12">
    <h1 class="page-header">FieldSelector</h1>

    <p>Field Selectors allow you to specify in a request exactly what data you
      wish to recieve in the response. This allows the client to get an efficient
      response with only the fields required.</p>
    <p>The fields can come from the endpointʼs associated Schema, or from an
      attribute exposed in any of the views of the resource. Multiple fields are
      separated by commas.</p>
    <p>You can also select properties from nested schemas from parent schema
      using curly braces. For example <code>title,user{name,email}</code> would lead to a
      response like this:</p>
    <pre>{
  "title": "Nice Blog Post",
  "user": {
    "name": "John Appleseed",
    "email": "john@example.com"
  }
}</pre>
    <p>If you do not specify attributes of nested properties, the <code>default</code>
      view will be used to render them.</p>
  </div>
</div>

Version data entries

15 entries across 15 versions & 1 rubygems

Version Path
praxis-2.0.pre.9 lib/api_browser/app/views/builtin/field-selector.html
praxis-2.0.pre.8 lib/api_browser/app/views/builtin/field-selector.html
praxis-2.0.pre.7 lib/api_browser/app/views/builtin/field-selector.html
praxis-2.0.pre.6 lib/api_browser/app/views/builtin/field-selector.html
praxis-2.0.pre.5 lib/api_browser/app/views/builtin/field-selector.html
praxis-2.0.pre.4 lib/api_browser/app/views/builtin/field-selector.html
praxis-2.0.pre.3 lib/api_browser/app/views/builtin/field-selector.html
praxis-2.0.pre.2 lib/api_browser/app/views/builtin/field-selector.html
praxis-2.0.pre.1 lib/api_browser/app/views/builtin/field-selector.html
praxis-0.22.pre.2 lib/api_browser/app/views/builtin/field-selector.html
praxis-0.22.pre.1 lib/api_browser/app/views/builtin/field-selector.html
praxis-0.21 lib/api_browser/app/views/builtin/field-selector.html
praxis-0.20.1 lib/api_browser/app/views/builtin/field-selector.html
praxis-0.20.0 lib/api_browser/app/views/builtin/field-selector.html
praxis-0.19.0 lib/api_browser/app/views/builtin/field-selector.html