Closed Rahuljagwani closed 1 month ago
This pull request introduces a new OpenAPI specification file for the crate_db microservice. The specification includes endpoints for managing RO-Crates and service information, along with detailed request and response schemas. It also defines common error responses for various HTTP status codes.
Files | Changes |
---|---|
crate_db/api/specs/crate_db_specs.yaml |
Introduced a comprehensive OpenAPI specification for the crate_db microservice, detailing endpoints, request/response schemas, and error handling. |
Issues in previous PR:
Problem: Previously the name of the schema containing service specs was Service
and the schema itself was redundant.(Link)
Fix: The name of the service was changed to ROCServiceInfo
and allof
was used in schema.(Link)
Problem: The whole request body was being sent in response again for POST operations.(Link) Fix: This was shortened the response to a message.(Link)
x-body-name
. Link
Fix: It was removed from everywhere.Problem: No custom messages and status code in Errors(eg. BadRequest, etc.) Link Fix: Solved by adding custom messages and status code in the respective errors. Link
Problem: Unnecessary parameters in ProblemDetails schema. Link
Fix: Limited to title
and status
only. Link
Problem: Unnecessary errors (404 and 400) for GET operation Fix: Removed
Other than above, the descriptions and messages have been shortened down for the sake of consistency.
@uniqueg As told, this PR contains only OpenAPI specifications.
Summary by Sourcery
This pull request adds OpenAPI specifications for the crate_db microservice, providing detailed documentation for endpoints related to managing RO-Crates and service information.