equinor / equinor/osdu-csharp-client

Include generated code or write documentation

Open
#63 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
C#
Stars
0
Forks
0
Avg merge
17h 6m
Merged PRs (30d)
37

Description

Currently there are no generated code in this repo (by design). This means that there are no option for a user to find what this client library has of features without reading the OpenAPI schemas or downloading the client and looking through the nuget packages.

To remedy this issue either include the generated code so a user can use references and search (in Github) or write in-depth documentation of the different client's different endpoints as well as expected response and request bodies.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the OpenAPI schemas and the generated client code in the NuGet packages to understand what users cannot currently discover in the repository. Clarify whether the accepted outcome is searchable generated source or in-depth endpoint documentation, then define completion as one of those options covering the clients, endpoints, and expected request and response bodies.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
api, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.