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

Changed category fields in /courses endpoint #1075

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

ArtemHolikov
Copy link
Contributor

Problem: Some category fields have an object with fields as an example, some have just string with id. Check courseService and update those examples with real values from API

Now: category fields changed to actual API response

@ArtemHolikov ArtemHolikov added bug Something isn't working documentation Improvements or additions to documentation Backend labels Dec 19, 2024
@ArtemHolikov ArtemHolikov self-assigned this Dec 19, 2024
Copy link
Contributor

@ShadowOfTheSpace ShadowOfTheSpace left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, check the references in cource-schema.yaml file. You are assigning a reference to a string field and, also they are not from components, you added them as definition.

image

@ArtemHolikov
Copy link
Contributor Author

Please, check the references in cource-schema.yaml file. You are assigning a reference to a string field and, also they are not from components, you added them as definition.

image

As I know, we return just id as a string, that's why it assigned as a string. And added ref to show which object we receive via this id. Regarding to problem with components/definitions, it's already done in my other PR. It defined as definitions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backend bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(SP: ) Swagger docs: incorrect Category examples in /courses endpoint
2 participants