Skip to content
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

External Example not shown #551

Closed
m-mohr opened this issue Jun 28, 2018 · 2 comments
Closed

External Example not shown #551

m-mohr opened this issue Jun 28, 2018 · 2 comments

Comments

@m-mohr
Copy link
Contributor

m-mohr commented Jun 28, 2018

I have this OpenAPI 3.0 specification:

...
    "/processes": {
      "get": {
        "summary": "List supported processes.",
        "description": "The request asks the back-end for available processes and returns detailed process descriptions, including parameters and return values. Processes are described using the Functio specification for language-agnostic process descriptions.",
        "tags": [
          "Process Discovery"
        ],
        "externalDocs": {
          "description": "Functio specification, version 0.1.0 (or any newer patch version).",
          "url": "https://github.com/m-mohr/functio-spec/blob/master/versions/0.1.0/spec.md"
        },
        "responses": {
          "200": {
            "description": "Functio document describing the supported processes.",
            "content": {
              "application/json": {
                "schema": {
                  "externalDocs": {
                    "description": "Functio specification, version 0.1.0 (or any newer patch version).",
                    "url": "https://github.com/m-mohr/functio-spec/blob/master/versions/0.1.0/spec.md"
                  }
                },
                "examples": {
                  "functioSpecExample": {
                    "externalValue": "https://raw.githubusercontent.com/m-mohr/functio-spec/master/versions/0.1.0/example.json"
                  }
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/client_error_auth"
          },
          "5XX": {
            "$ref": "#/components/responses/server_error"
          }
        }
      }
    },
...

The example is not rendered by ReDoc as you can see here:
https://open-eo.github.io/openeo-api/v/0.3.0/apireference/index.html#/paths/~1processes/get

Would be helpful to have this feature implemented.

@RomanHotsiy
Copy link
Member

Thanks for feature request!
Will be definitely implemented

RomanHotsiy added a commit that referenced this issue Mar 11, 2019
@RomanHotsiy
Copy link
Member

Implemented in 2cdfcd2

The new release is coming tomorrow.

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

No branches or pull requests

2 participants