Add 404 spec for delete index, get document, delete document APIs #589

imvtsl · 2024-09-28T05:27:18Z

Signed-off-by: Vatsal vatsal.v.anand@gmail.com

Description

Added 404 spec for below APIs

DELETE /{index}
GET /{index}/_doc/{id}
DELETE /{index}/_doc/{id}

Issues Resolved

Contributes to #445

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

imvtsl · 2024-09-28T05:36:40Z

Hi @dblock

Doc tests are failing for GET and DELETE /{index}/_doc/{id} in case of 404:

[INFO] => GET /movies/_doc/1 ({}) [application/json] 
[INFO] <= 404 (application/json) | Not Found
[INFO] # {
  "$ref": "#/components/schemas/_core.get:GetResult",
  "type": "object",
  "unevaluatedProperties": {
    "not": true,
    "errorMessage": "property is not defined in the spec"
  }
}
[INFO] * undefined
[INFO] & "data must be object, data must be object"
[INFO] => DELETE /movies/_doc/1 ({}) [application/json] 
[INFO] <= 404 (application/json) | Not Found
[INFO] # {
  "$ref": "#/components/schemas/_common:WriteResponseBase",
  "type": "object",
  "unevaluatedProperties": {
    "not": true,
    "errorMessage": "property is not defined in the spec"
  }
}
[INFO] * undefined
[INFO] & "data must be object, data must be object"


FAILED  doc.yaml (tests/default/indices/doc.yaml)
    FAILED  CHAPTERS
        PASSED  Create a document.
            PASSED  PARAMETERS
                PASSED  index
            PASSED  REQUEST BODY
            PASSED  RESPONSE STATUS
            PASSED  RESPONSE PAYLOAD BODY
            PASSED  RESPONSE PAYLOAD SCHEMA
            SKIPPED RESPONSE OUTPUT VALUES
        PASSED  Create a document.
            PASSED  PARAMETERS
                PASSED  index
                PASSED  id
            PASSED  REQUEST BODY
            PASSED  RESPONSE STATUS
            PASSED  RESPONSE PAYLOAD BODY
            PASSED  RESPONSE PAYLOAD SCHEMA
            SKIPPED RESPONSE OUTPUT VALUES
        PASSED  Update a document.
            PASSED  PARAMETERS
                PASSED  index
                PASSED  id
            PASSED  REQUEST BODY
            PASSED  RESPONSE STATUS
            PASSED  RESPONSE PAYLOAD BODY
            PASSED  RESPONSE PAYLOAD SCHEMA
            SKIPPED RESPONSE OUTPUT VALUES
        PASSED  Retrieve a document.
            PASSED  PARAMETERS
                PASSED  index
                PASSED  id
            PASSED  REQUEST BODY
            PASSED  RESPONSE STATUS
            PASSED  RESPONSE PAYLOAD BODY
            PASSED  RESPONSE PAYLOAD SCHEMA
            SKIPPED RESPONSE OUTPUT VALUES
        PASSED  Delete a document.
            PASSED  PARAMETERS
                PASSED  index
                PASSED  id
            PASSED  REQUEST BODY
            PASSED  RESPONSE STATUS
            PASSED  RESPONSE PAYLOAD BODY
            PASSED  RESPONSE PAYLOAD SCHEMA
            SKIPPED RESPONSE OUTPUT VALUES
        FAILED  Retrieve a non existing document.
            PASSED  PARAMETERS
                PASSED  index
                PASSED  id
            PASSED  REQUEST BODY
            PASSED  RESPONSE STATUS
            PASSED  RESPONSE PAYLOAD BODY
            FAILED  RESPONSE PAYLOAD SCHEMA (data must be object, data must be object)
            SKIPPED RESPONSE OUTPUT VALUES
        FAILED  Delete a non existing document.
            PASSED  PARAMETERS
                PASSED  index
                PASSED  id
            PASSED  REQUEST BODY
            PASSED  RESPONSE STATUS
            PASSED  RESPONSE PAYLOAD BODY
            FAILED  RESPONSE PAYLOAD SCHEMA (data must be object, data must be object)
            SKIPPED RESPONSE OUTPUT VALUES
    PASSED  EPILOGUES
        PASSED  DELETE /movies

It gives error "(data must be object, data must be object)", "errorMessage": "property is not defined in the spec"
However, GET and DELETE /{index}/_doc/{id} with 200 are PASSED and they use same schema as 404. So, I am not sure why we get this error. What am I missing? Can you help me fix this? This is my first contribution to this repo, appreciate the help. Thanks.

dblock · 2024-09-30T12:22:32Z

This error means that for a deleted document there's no data returned, however we can see that it's not true.

$ curl -s -k -u admin:$OPENSEARCH_PASSWORD  -X POST https://localhost:9200/movies/_doc/1 --json {} | jq
{
  "_index": "movies",
  "_id": "1",
  "_version": 2,
  "result": "updated",
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 1,
  "_primary_term": 1
}

$ curl -s -k -u admin:$OPENSEARCH_PASSWORD  -X DELETE https://localhost:9200/movies/_doc/1 | jq
{
  "_index": "movies",
  "_id": "1",
  "_version": 3,
  "result": "deleted",
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 2,
  "_primary_term": 1
}

$ curl -s -k -u admin:$OPENSEARCH_PASSWORD  -X GET https://localhost:9200/movies/_doc/1 | jq
{
  "_index": "movies",
  "_id": "1",
  "found": false
}

Looking at the code we do something funky with the errors here: https://github.com/opensearch-project/opensearch-api-specification/blob/main/tools/src/tester/ChapterReader.ts#L65. If the response contains a JSON error we return it, otherwise we return nothing, so this explains why the response is nothing. This looks like a non-standard 404 response.

Here's a quick fix.

diff --git a/tools/src/tester/ChapterReader.ts b/tools/src/tester/ChapterReader.ts
index 26dd027..f85e6fd 100644
--- a/tools/src/tester/ChapterReader.ts
+++ b/tools/src/tester/ChapterReader.ts
@@ -62,7 +62,7 @@ export default class ChapterReader {
         response.status = e.response.status
         response.content_type = e.response.headers['content-type']?.split(';')[0]
         const payload = this.#deserialize_payload(e.response.data, response.content_type)
-        if (payload !== undefined) response.payload = payload.error
+        if (payload !== undefined) response.payload = payload.error ?? payload
         response.message = payload.error?.reason ?? e.response.statusText

It needs a test, feel free to add one or if it's too much work open an issue and I'll take care of it.

imvtsl · 2024-10-01T02:17:58Z

@dblock Thanks for quick response. Doc tests are now working with the suggested change.
I added a test for this change in ChapterReader.ts. I have limited experience with TypeScript, but I have verified the coverage and result of this new test.
Please review.

dblock

Looks good! Test works well. Rebase and we'll merge?

Signed-off-by: Vatsal <vatsal.v.anand@gmail.com>

imvtsl · 2024-10-02T01:01:24Z

Rebase done.

github-actions · 2024-10-02T11:40:59Z

Changes Analysis

Commit SHA: c7bae5d
Comparing To SHA: 939a292

API Changes

Summary

├─┬Paths
│ ├─┬/{index}
│ │ └─┬DELETE
│ │   └─┬Responses
│ │     └──[➕] codes (27887:7)
│ └─┬/{index}/_doc/{id}
│   ├─┬GET
│   │ └─┬Responses
│   │   └──[➕] codes (27727:7)
│   └─┬DELETE
│     └─┬Responses
│       └──[➕] codes (27439:7)
└─┬Components
  ├──[➕] responses (27887:7)
  ├──[➕] responses (27727:7)
  ├──[➕] responses (27439:7)
  ├──[➕] schemas (31347:7)
  └──[➕] schemas (47307:7)

Document Element	Total Changes	Breaking Changes
paths	3	0
components	5	0

Total Changes: 8
Additions: 8

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/11189230449/artifacts/2019049822

API Coverage

	Before	After	Δ
Covered (%)	588 (57.59 %)	588 (57.59 %)	0 (0 %)
Uncovered (%)	433 (42.41 %)	433 (42.41 %)	0 (0 %)
Unknown	29	29	0

github-actions · 2024-10-02T11:41:10Z

Spec Test Coverage Analysis

Total	Tested
504	303 (60.12 %)

dblock · 2024-10-02T11:46:40Z

Looks like some more lint/validate failures, thanks!

Signed-off-by: Vatsal <vatsal.v.anand@gmail.com>

dblock · 2024-10-03T12:53:17Z

The validation is correct. The contents of the get@404 can be the same as get@200, but you do need 2 response objects.

Signed-off-by: Vatsal <vatsal.v.anand@gmail.com>

imvtsl · 2024-10-03T20:26:47Z

I created new keys, get@404 and delete@404. However, I used anchors to reuse value from get@200 key. This way, we have two keys and we avoid duplication of values.

Let me know if we don't want to use anchors but want to duplicate values.

dblock · 2024-10-04T12:27:30Z

spec/namespaces/_core.yaml

@@ -2837,11 +2841,12 @@ components:
              creation_time:
                type: integer
                format: int64
-    delete@200:
+    delete@200: &WriteResponseBase


This is an interesting syntax! Where can I read about & and *?

Thanks.
I referred these resources before implementing:

https://yaml.org/spec/1.2.2/#692-node-anchors

https://support.atlassian.com/bitbucket-cloud/docs/yaml-anchors/

dblock · 2024-10-04T12:28:24Z

Let me know if we don't want to use anchors but want to duplicate values.

The rest of the docs do not use anchors, maybe let's keep that to be consistent, and open an issue to edit everything not to?

Signed-off-by: Vatsal <vatsal.v.anand@gmail.com>

imvtsl · 2024-10-05T00:33:10Z

I removed anchors to maintain consistency.

open an issue to edit everything not to?

I don't really follow this part. Could you help elaborate? Thanks.

dblock · 2024-10-05T01:08:51Z

open an issue to edit everything not to?

I don't really follow this part. Could you help elaborate? Thanks.

I mean if you think it's better/cleaner/faster/prettier to use anchors then you can suggest we change to use them everywhere in a new issue. We value your opinion and we can discuss the pros/cons on GitHub.

Thanks for your help with this!

dblock

Spotted a grammar thing, sorry to be annoying! I promise that's it after that one :)

tests/default/indices/doc.yaml

Signed-off-by: Vatsal <vatsal.v.anand@gmail.com>

imvtsl · 2024-10-05T01:26:26Z

I mean if you think it's better/cleaner/faster/prettier to use anchors then you can suggest we change to use them everywhere in a new issue.

I will analyze yaml files in this repo and check if we should use anchors and create issue.

Spotted a grammar thing, sorry to be annoying!

No worries!

imvtsl force-pushed the issue-445 branch from fe1b104 to bf61999 Compare October 1, 2024 02:04

imvtsl marked this pull request as ready for review October 1, 2024 02:18

imvtsl requested review from dblock, harshavamsi, sachetalva, nhtruong, Xtansia, VachaShah, Tokesh and aabeshov as code owners October 1, 2024 02:18

dblock previously approved these changes Oct 1, 2024

View reviewed changes

imvtsl added 4 commits October 1, 2024 17:54

Add 404 spec for delete index, get document, delete document APIs

5869c24

Signed-off-by: Vatsal <vatsal.v.anand@gmail.com>

Add 404 spec for delete index, get document, delete document APIs

3b4b433

Signed-off-by: Vatsal <vatsal.v.anand@gmail.com>

Add 404 spec for delete index, get document, delete document APIs

d75ca09

Signed-off-by: Vatsal <vatsal.v.anand@gmail.com>

Add 404 spec for delete index, get document, delete document APIs

20e89d9

Signed-off-by: Vatsal <vatsal.v.anand@gmail.com>

imvtsl dismissed dblock’s stale review via 20e89d9 October 2, 2024 00:57

imvtsl force-pushed the issue-445 branch from 989ae56 to 20e89d9 Compare October 2, 2024 00:57

imvtsl requested a review from dblock October 2, 2024 01:00

Add 404 spec for delete index, get document, delete document APIs

5be99e6

Signed-off-by: Vatsal <vatsal.v.anand@gmail.com>

Add 404 spec for delete index, get document, delete document APIs

c1039de

Signed-off-by: Vatsal <vatsal.v.anand@gmail.com>

dblock reviewed Oct 4, 2024

View reviewed changes

Add 404 spec for delete index, get document, delete document APIs

db5705b

Signed-off-by: Vatsal <vatsal.v.anand@gmail.com>

dblock requested changes Oct 5, 2024

View reviewed changes

tests/default/indices/doc.yaml Outdated Show resolved Hide resolved

Add 404 spec for delete index, get document, delete document APIs

c7bae5d

Signed-off-by: Vatsal <vatsal.v.anand@gmail.com>

imvtsl requested a review from dblock October 5, 2024 01:26

dblock approved these changes Oct 5, 2024

View reviewed changes

dblock merged commit 118be4f into opensearch-project:main Oct 5, 2024
21 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add 404 spec for delete index, get document, delete document APIs #589

Add 404 spec for delete index, get document, delete document APIs #589

imvtsl commented Sep 28, 2024

imvtsl commented Sep 28, 2024 •

edited

Loading

dblock commented Sep 30, 2024 •

edited

Loading

imvtsl commented Oct 1, 2024

dblock left a comment

imvtsl commented Oct 2, 2024

github-actions bot commented Oct 2, 2024 •

edited

Loading

github-actions bot commented Oct 2, 2024

dblock commented Oct 2, 2024

dblock commented Oct 3, 2024

imvtsl commented Oct 3, 2024 •

edited

Loading

dblock Oct 4, 2024

imvtsl Oct 5, 2024

dblock commented Oct 4, 2024

imvtsl commented Oct 5, 2024

dblock commented Oct 5, 2024 •

edited

Loading

dblock left a comment

imvtsl commented Oct 5, 2024

Add 404 spec for delete index, get document, delete document APIs #589

Add 404 spec for delete index, get document, delete document APIs #589

Conversation

imvtsl commented Sep 28, 2024

Description

Issues Resolved

imvtsl commented Sep 28, 2024 • edited Loading

dblock commented Sep 30, 2024 • edited Loading

imvtsl commented Oct 1, 2024

dblock left a comment

Choose a reason for hiding this comment

imvtsl commented Oct 2, 2024

github-actions bot commented Oct 2, 2024 • edited Loading

Changes Analysis

API Changes

Summary

Report

API Coverage

github-actions bot commented Oct 2, 2024

Spec Test Coverage Analysis

dblock commented Oct 2, 2024

dblock commented Oct 3, 2024

imvtsl commented Oct 3, 2024 • edited Loading

dblock Oct 4, 2024

Choose a reason for hiding this comment

imvtsl Oct 5, 2024

Choose a reason for hiding this comment

dblock commented Oct 4, 2024

imvtsl commented Oct 5, 2024

dblock commented Oct 5, 2024 • edited Loading

dblock left a comment

Choose a reason for hiding this comment

imvtsl commented Oct 5, 2024

imvtsl commented Sep 28, 2024 •

edited

Loading

dblock commented Sep 30, 2024 •

edited

Loading

github-actions bot commented Oct 2, 2024 •

edited

Loading

imvtsl commented Oct 3, 2024 •

edited

Loading

dblock commented Oct 5, 2024 •

edited

Loading