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

api: provide consistent names for endpoints using summary property #70

Merged
merged 1 commit into from
Jul 8, 2024

Conversation

philipnbbc
Copy link
Contributor

Details

The changes provide a more human friendly name for the endpoints in the Stoplight rendered documentation.

Pivotal Story (if relevant)

Story URL: https://www.pivotaltracker.com/story/show/187659593

Related PRs

Where appropriate. Indicate order to be merged.

Submitter PR Checks

(tick as appropriate)

  • PR completes task/fixes bug
  • API version has been incremented if necessary
  • ADR status has been updated, and ADR implementation has been recorded
  • Documentation updated (README, etc.)
  • PR added to Pivotal story (if relevant)
  • Follow-up stories added to Pivotal

Reviewer PR Checks

(tick as appropriate)

  • PR completes task/fixes bug
  • Design makes sense, and fits with our current code base
  • Code is easy to follow
  • PR size is sensible
  • Commit history is sensible and tidy

Info on PRs

The checks above are guidelines. They don't all have to be ticked, but they should all have been considered.

@philipnbbc philipnbbc requested a review from a team as a code owner July 1, 2024 14:33
@samdbmg samdbmg self-assigned this Jul 4, 2024
This provides a more human friendly name for the endpoints in the
Stoplight rendered documentation.
@philipnbbc philipnbbc force-pushed the philipn-better-endpoint-names branch from ec4d315 to 4b24a8d Compare July 8, 2024 08:10
@philipnbbc philipnbbc merged commit 9c29fc4 into main Jul 8, 2024
5 checks passed
@philipnbbc philipnbbc deleted the philipn-better-endpoint-names branch July 8, 2024 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants