dfinity / dfinity/pocketic

Responses Missing from OpenAPI Specification

Open
#15 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
35
Forks
6
Avg merge
9m
Merged PRs (30d)
1

Description

The POST response bodies are not included in the OAS exposed by PocketIC's /api.json endpoint.

Example:

{
  ...
  "/instances/": {
    "get": {
      "responses": {
        "200": {
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "post": {
      "requestBody": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ExtendedSubnetConfigSet"
            }
          }
        },
        "required": true
      }
    }
  },
  ...
}

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at PocketIC's /api.json endpoint and inspect the generated OpenAPI entry for POST /instances/. Compare it with the included GET response example, then verify that the POST operation exposes its response body and schema in the generated specification.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
40/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.