Skip to content

Commit

Permalink
style(api-docs): clean up api documentation.
Browse files Browse the repository at this point in the history
Previously, it was not possible to check request/response bodies samples in API documentation. This commit solves this error by refactoring the API documentation by using yaml for all api schemas/samples and decomposition of the open-api.yaml file.

- decompose the mod-search.yaml file.
- move all the paths into separate yaml files with corresponded folders inside paths folder.
- move all the parameters into separate yaml files inside the parameters folder.
- create yaml versions for all the examples.
- create yaml versions for all the schemas.
- delete example files with sample extension.
- delete schemas files with json extension.

Closes MSEARCH-546.
  • Loading branch information
GeloPakDev1 committed Mar 27, 2024
1 parent 923c29f commit 0d4c337
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
in: query
name: sortOrder
description: Defines sorting order
description: 'Defines sorting order'
required: false
schema:
$ref: '../schemas/entity/sortOrder.yaml'
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ post:
content:
application/json:
example:
$ref: '../../examples/request/indexRecordRequestBody.yaml'
- $ref: '../../examples/request/indexRecordRequestBody.yaml'
schema:
$ref: '../../schemas/request/indexRecordRequest.yaml'
responses:
Expand Down

0 comments on commit 0d4c337

Please sign in to comment.