Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in
  • G git-eca-rest-api
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 15
    • Issues 15
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
    • Requirements
  • Merge requests 0
    • Merge requests 0
  • Deployments
    • Deployments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • Code review
    • Insights
    • Issue
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar
  • Eclipse FoundationEclipse Foundation
  • IT
  • APIs
  • git-eca-rest-api
  • Issues
  • #109
Closed
Open
Issue created Dec 19, 2022 by Martin Lowe@malowe🇨🇦Maintainer

Update docs for reports endpoint usage

There was a request in the MBO sign-off call to document the private-proejcts endpoint more thoroughly. It is an endpoint that will see infrequent usage, and we want to make sure there is up to date documentation outside of just the openapi spec on usage. While the openapi spec denotes how this is used, we will want to also give more contextual information in an easier-to-consume manner, such as volatile vs non-volatile fields. We will want to denote which fields should be stable like the GitLab user and project IDs, and fields that are more mutable like parent project, EF username, and deletion/creation date. A model for how we might want to present this is the VC tools usage section in the README. It's clean and thorough and is the model of what the ideal documentation is across our products.

Additionally, we will want to add the missing key query parameter that was missed when I was adding the feature last week.

Assignee
Assign to
Time tracking

Copyright © Eclipse Foundation, Inc. All Rights Reserved.     Privacy Policy | Terms of Use | Copyright Agent