github.com/tickoalcantara12/micro/v3@v3.0.0-20221007104245-9d75b9bcbab9/cmd/protoc-gen-openapi/README.md (about)

     1  protoc-gen-openapi
     2  ==================
     3  
     4  Generate an OpenAPI 3 spec for the Micro API from your Micro service proto.
     5  
     6  
     7  Todo
     8  ----
     9  
    10  - [x] Read proto files
    11  - [x] Output OpenAPI3 JSON spec
    12      - [x] Info.Title comes from the proto package name
    13  - [x] Build a map of "Schemas" (one for each "message")
    14      - [x] Field descriptions from code
    15      - [ ] Possible to use references? Not for v1
    16  - [x] Add a "Path" for each proto "service" method
    17      - [x] Summary is proto filename and service.method
    18      - [ ] Description is comments from code
    19      - [x] app/json RequestBody payload from message "input" schema
    20      - [x] app/json Response payload from message "output" schema
    21          - [x] Default error payloads
    22  - [x] Add a "Server" for each Micro platform API endpoint (dev / prod etc)
    23  - [x] Auth with API token (according to docs)
    24  - [ ] Parameters
    25      - [x] Namespace (as a header)
    26      - [ ] Namespace (as a hostname component, but this invites errors)
    27      - [x] Service name (as first part of the URL path)
    28  
    29  
    30  References aren't working (request/responses should reference a schema)
    31  
    32  
    33  Links
    34  -----
    35  
    36  - https://micro.dev/reference#api