ansys / ansys/api-eigen-example

Consider OpenAPI

Open
#54 3 comments 2 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
8
Forks
0
Avg merge
11h 54m
Merged PRs (30d)
10

Description

OpenAPI provides a way to [declare your RESTful API](https://swagger.io/specification/), much like .proto files in gRPC, and have server stubs and client proxies be auto-generated for a variety of languages. It would be a much less error prone and maintainable way for us to declare our RESTful APIs.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing how this repository currently declares its RESTful APIs and how its .proto files support gRPC. Compare the existing approach with OpenAPI's specification, server stubs, and client proxies; the issue does not define a target scope or acceptance criteria, so completion is not currently clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
grpc, openapi, python
Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.