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

Document Provider Service Request/Response Models #519

Closed
5 tasks done
Tracked by #408
lucasamonrc opened this issue Mar 29, 2022 · 0 comments · Fixed by #600
Closed
5 tasks done
Tracked by #408

Document Provider Service Request/Response Models #519

lucasamonrc opened this issue Mar 29, 2022 · 0 comments · Fixed by #600
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@lucasamonrc
Copy link
Contributor

lucasamonrc commented Mar 29, 2022

For each endpoint call, document the following things:

Description

Ideally coming from the proto file, this description should include a high level explanation of the functionality
How might we import this content directly from the proto file's service?

Request and Response Data Models

Links to the data models for the request and response bodies should be included. Just the links to the data models are needed within the reference markdown file, not the full tables of the data models - but that would be cool.

Coverage Status

  • Invite participant
  • Check invitation status
  • Create ecosystem
  • List ecosystems
  • Accept invitation
@lucasamonrc lucasamonrc mentioned this issue Mar 29, 2022
6 tasks
@lucasamonrc lucasamonrc changed the title Provider Service Document Provider Service Request/Response Models Mar 29, 2022
@lucasamonrc lucasamonrc self-assigned this Mar 29, 2022
@lucasamonrc lucasamonrc added the documentation Improvements or additions to documentation label Mar 29, 2022
@lucasamonrc lucasamonrc added this to the 2022 Q1 milestone Mar 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant