Skip to content
This repository was archived by the owner on Oct 17, 2022. It is now read-only.

Conversation

@b0wter
Copy link
Contributor

@b0wter b0wter commented Oct 13, 2020

Overview

I am opening this pr in reference to #598
I've updated the following:

  1. added a missing status code (404)
  2. removed partial_filter_selector from the query parameters (since it should be a property of the index parameter)
  3. updated the index query parameter (it is no longer a list of strings but a json object)
  4. changed the example that showcases the use of all query parameters

Testing recommendations

Use any tool to send a http request to couchdb using the example given in the pr. I've tested it with Couch DB 3.1.1 and get the following response:

result": "exists",
    "id": "_design/example-ddoc",
    "name": "example-index"
}

(I've run multiple tests that's why the index already exists)

Checklist

@wohali wohali changed the base branch from master to main November 30, 2020 18:49
Copy link
Member

@wohali wohali left a comment

Choose a reason for hiding this comment

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

Minor formatting changes - overall this looks good.

syntax <find/sort>`. Nested fields are also allowed, e.g. `"person.name"`.
The index object is a JSON object with the following fields:

- ``fields``: array of field names following the :ref:`sort
Copy link
Member

Choose a reason for hiding this comment

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

This section should be formatted similar to this:

https://github.com/apache/couchdb-documentation/blame/main/src/api/server/common.rst#L644-L658

Use the same :json ... type structure so that all of the fields render correctly.

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've updated the PR. Here is a screenshot of what the new part looks like:

image

Let me know if this is not the way it's supposed to be :)

@wohali
Copy link
Member

wohali commented Dec 1, 2020

Thanks @b0wter !

@wohali wohali merged commit 9ff6d4c into apache:main Dec 1, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants