Skip to content

Update getting-started.asciidoc #40393

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

Merged
merged 3 commits into from
Jul 16, 2019
Merged

Update getting-started.asciidoc #40393

merged 3 commits into from
Jul 16, 2019

Conversation

magnusram05
Copy link
Contributor

hits.sort contain values not keys

  {
    "_index" : "bank",
    "_type" : "_doc",
    "_id" : "1",
    "_score" : null,
    "_source" : {
      "account_number" : *1*,
      "balance" : 39225,
      "firstname" : "Amber",
      "lastname" : "Duke",
      "age" : 32,
      "gender" : "M",
      "address" : "880 Holmes Lane",
      "employer" : "Pyrami",
      "email" : "[email protected]",
      "city" : "Brogan",
      "state" : "IL"
    },
    "sort" : [
      *1*
    ]
  },
  {
    "_index" : "bank",
    "_type" : "_doc",
    "_id" : "2",
    "_score" : null,
    "_source" : {
      "account_number" : *2*,
      "balance" : 28838,
      "firstname" : "Roberta",
      "lastname" : "Bender",
      "age" : 22,
      "gender" : "F",
      "address" : "560 Kingsway Place",
      "employer" : "Chillium",
      "email" : "[email protected]",
      "city" : "Bennett",
      "state" : "LA"
    },
    "sort" : [
      *2*
    ]
  },
  • Have you signed the contributor license agreement?
  • Have you followed the contributor guidelines?
  • If submitting code, have you built your formula locally prior to submission with gradle check?
  • If submitting code, is your pull request against master? Unless there is a good reason otherwise, we prefer pull requests against master and will backport as needed.
  • If submitting code, have you checked that your submission is for an OS that we support?
  • If you are submitting this code for a class then read our policy for that.

hits.sort contain values not keys

      {
        "_index" : "bank",
        "_type" : "_doc",
        "_id" : "1",
        "_score" : null,
        "_source" : {
          "account_number" : *1*,
          "balance" : 39225,
          "firstname" : "Amber",
          "lastname" : "Duke",
          "age" : 32,
          "gender" : "M",
          "address" : "880 Holmes Lane",
          "employer" : "Pyrami",
          "email" : "[email protected]",
          "city" : "Brogan",
          "state" : "IL"
        },
        "sort" : [
          *1*
        ]
      },
      {
        "_index" : "bank",
        "_type" : "_doc",
        "_id" : "2",
        "_score" : null,
        "_source" : {
          "account_number" : *2*,
          "balance" : 28838,
          "firstname" : "Roberta",
          "lastname" : "Bender",
          "age" : 22,
          "gender" : "F",
          "address" : "560 Kingsway Place",
          "employer" : "Chillium",
          "email" : "[email protected]",
          "city" : "Bennett",
          "state" : "LA"
        },
        "sort" : [
          *2*
        ]
      },
@colings86 colings86 added >docs General docs changes :Docs labels Mar 25, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

Copy link
Member

@cbuescher cbuescher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @magnusram05, thanks for taking an interest in the getting-started docs. I left a small comment which might even improve upon your suggested edit. If you agree just push the change and I can run the tests and merge.

@@ -788,7 +788,7 @@ As for the response, we see the following parts:
* `hits` – search results
* `hits.total` – total number of documents matching our search criteria
* `hits.hits` – actual array of search results (defaults to first 10 documents)
* `hits.sort` - sort key for results (missing if sorting by score)
* `hits.sort` - sort value for results (missing if sorting by score)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if you really want to be fussy, it could probably be "value of the sort key for each result"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have made the changes.

@javanna
Copy link
Member

javanna commented Jul 15, 2019

hi @magnusram05 do you plan on updating your PR based on the comment above?

@magnusram05
Copy link
Contributor Author

magnusram05 commented Jul 15, 2019 via email

Fixed review comment
@cbuescher
Copy link
Member

@elasticmachine test this please

Copy link
Member

@cbuescher cbuescher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making the change, LGTM.
I will merge this to 6.6 and later branches.

@cbuescher
Copy link
Member

@elasticmachine update branch

@cbuescher
Copy link
Member

@elasticmachine test this please

@cbuescher
Copy link
Member

@magnusram05 thanks for the change, I merged it to all relevant branches.

@magnusram05
Copy link
Contributor Author

magnusram05 commented Jul 16, 2019 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants