Skip to content

OpenAPI + Docs Update for Stories #58

Description

@ArchILLtect

Summary

Update openapi/sameboat.yaml and docs (docs/api.md, README.md) to include Stories endpoints and error envelopes.

Motivation / Problem

Keep API contract documented and discoverable for frontend integration.

Acceptance Criteria

  • OpenAPI includes POST/GET feed/GET me/DELETE with request/response schemas and error envelopes.
  • docs/api.md shows sample requests/responses and error cases.
  • README adds short Stories note and migration reference.

Target Release

v0.2.0

Notes / Links

docs/weekly-plan/week-5/week-5-plan-backend.md
docs/weekly-plan/week-5/week-5-plan-issues.md

No activity

Activity on this issue will appear here.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    apiIssues/PRs dealing with REST endpoints.area:storiesIssues/PRs related to the Stories domain (entity, repository, service, controller, feed, deletion)backendWork related to APIs, services, or controllers.documentationImprovements or additions to documentationroadmapPlanned feature or strategic goal from the project roadmap.type:docsSecurity-related changes, fixes, or enhancements.type:featureNew feature related to backend types, DTOs, or models.

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions