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

FIX: OpenAPI Spec Generation on macOS #4495

Open
Olshansk opened this issue Feb 5, 2025 · 0 comments
Open

FIX: OpenAPI Spec Generation on macOS #4495

Olshansk opened this issue Feb 5, 2025 · 0 comments

Comments

@Olshansk
Copy link

Olshansk commented Feb 5, 2025

Context: OpenAPI Spec Generation not working as expected

The following command works on linux but not macOS

ignite generate openapi --yes

Details & Steps to Reproduce

  1. Reference repo: https://github.com/pokt-network/poktroll

  2. Reference ticket: [API] OpenAPI Spec Fixes pokt-network/poktroll#988

  3. Workaround: [OpenAPI] Add Dockerfile to reliability generate the OpenAPI spec using ignite pokt-network/poktroll#1055

  4. Expected output: https://github.com/pokt-network/poktroll/blob/main/docs/static/openapi.yml

  5. Actual output:

    Empty OpenAPI spec output on macOS
    {
      "id": "github.com/pokt-network/poktroll",
      "consumes": ["application/json"],
      "produces": ["application/json"],
      "swagger": "2.0",
      "info":
        {
          "description": "Chain github.com/pokt-network/poktroll REST API",
          "title": "HTTP API Console",
          "contact": { "name": "github.com/pokt-network/poktroll" },
          "version": "version not set",
        },
      "paths": {},
      "definitions":
        {
          "google.protobuf.Any":
            {
              "type": "object",
              "properties": { "@type": { "type": "string" } },
              "additionalProperties": {},
            },
          "google.rpc.Status":
            {
              "type": "object",
              "properties":
                {
                  "code": { "type": "integer", "format": "int32" },
                  "details":
                    {
                      "type": "array",
                      "items":
                        {
                          "type": "object",
                          "$ref": "#/definitions/google.protobuf.Any",
                        },
                    },
                  "message": { "type": "string" },
                },
            },
        },
    }
commoddity added a commit to pokt-network/poktroll that referenced this issue Feb 5, 2025
…sing `ignite` (#1055)

## Summary

Adds a Dockerfile to build the outputted OpenAPI spec in a way that will
work on all dev environments.


## Issue

-
https://discord.com/channels/824324475256438814/997192534168182905/1336447458128957523
- #1054 
- #988
- ignite/cli#4495

## Type of change

Select one or more from the following:

- [x] New feature, functionality or library
- [ ] Consensus breaking; add the `consensus-breaking` label if so. See
#791 for details
- [ ] Bug fix
- [x] Code health or cleanup
- [ ] Documentation
- [ ] Other (specify)

## Sanity Checklist

- [ ] I have updated the GitHub Issue `assignees`, `reviewers`,
`labels`, `project`, `iteration` and `milestone`
- [ ] For docs, I have run `make docusaurus_start`
- [ ] For code, I have run `make go_develop_and_test` and `make
test_e2e`
- [ ] For code, I have added the `devnet-test-e2e` label to run E2E
tests in CI
- [ ] For configurations, I have update the documentation
- [ ] I added TODOs where applicable

---------

Co-authored-by: Daniel Olshansky <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: To Discuss
Development

No branches or pull requests

1 participant