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

Some externalDocs missing from OpenAPI document #3043

Open
lcawl opened this issue Oct 22, 2024 · 0 comments
Open

Some externalDocs missing from OpenAPI document #3043

lcawl opened this issue Oct 22, 2024 · 0 comments
Labels

Comments

@lcawl
Copy link
Contributor

lcawl commented Oct 22, 2024

The @ext_doc_id modifier was added in #3028
While using it in #3023, it was noticeable that some occurrences were correctly shown in the schema.json (by running make generate) but missing from the OpenAPI documents (by running make transform-to-openapi).

For example, if I add the following in specification/_global/search/_types/FieldCollapse.ts:

/**
 * @ext_doc_id collapse-search-results
 */
export class FieldCollapse {
...

... The schema.json contains:

      "kind": "interface",
      "extDocId": "collapse-search-results",
      "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/collapse-search-results.html",
      "name": {
        "name": "FieldCollapse",
        "namespace": "_global.search._types"
...

But there is no corresponding change to the OpenAPI document.

I did not identify the pattern of why certain occurrences were missing, but it will warrant further investigation if we implement more of those links. It might be as simple as neglecting to add support for @ext_doc_id on one of the specification data types. Alternatively, it seems to me it might reasonably be related to the sibling issue described in #2918

This issue serves as a reminder to dig deeper into this issue so we make full use of all those links we're adding.

@lcawl lcawl added the OpenAPI label Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant