cdisc-org / cdisc-org/COSMoS

As a developer I want the API specification so the user can have text search of conceptual BCs

Open
#32 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
SAS
Stars
33
Forks
7
PR merge metrics
No merged PRs in 30d

Description

**Description**

- As a developer, I want API spec tto have text type search of conceptual BCs via API endpoints.
User stories were created in PBI 4742 (User Stories for Retrieval of Conceptual BCs via APIs).

**Acceptance Criteria**

- An initial API specification has been designed with Swagger following the OpenAPI specification version 3, allowing users to search conceptual BCs using API endpoints.
- This is not the actual implementation (design only)
- Artifacts of this story will be in the COSMoS repo

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing PBI 4742, the related user stories for retrieval of conceptual BCs via APIs, and the COSMoS repository. Define the initial Swagger specification using OpenAPI 3 for text search through API endpoints; done means the specification artifact is present in the repository and no implementation is included.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.