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

[Doc rework] api.md file modification #1332

Merged
merged 36 commits into from
May 9, 2023
Merged

[Doc rework] api.md file modification #1332

merged 36 commits into from
May 9, 2023

Conversation

mapedraza
Copy link
Collaborator

@mapedraza mapedraza commented Mar 30, 2023

This PR is the first in the serie of #1329

This PR modifies api.md file

Documents to be integrated in:

Current file Current content Future file
advanced-topics.md specific topics api.md
api.md API description api.md
expressionLanguage.md Information about expressions api.md

Task:

Comment on lines +166 to +168

# DB Models (from API document)

Copy link
Collaborator Author

@mapedraza mapedraza Mar 30, 2023

Choose a reason for hiding this comment

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

This new section is created, as draft to contains the relationship between database terms and API terms. This information is not required for API users, but it is useful for developers.

A subsequent PR will work on this document integrating in a better way this information

@mapedraza mapedraza changed the base branch from master to task/doc-rework March 31, 2023 07:38
@fgalan
Copy link
Member

fgalan commented Mar 31, 2023

Initial commit on this PR (fd2435f) reviewed and LGTM. Next pieces of work will come in independent PRs on task/doc-rework.

@mapedraza mapedraza mentioned this pull request Apr 4, 2023
2 tasks
@mapedraza mapedraza changed the title [WIP] [Doc rework] api.md file modification [Doc rework] api.md file modification May 9, 2023
@mapedraza
Copy link
Collaborator Author

As discussed in a separate meeting, it makes sense to merge this PR directly on master branch, in order to avoid future conflicts with new features. Thus, i change the destination branch to master

@mapedraza mapedraza marked this pull request as ready for review May 9, 2023 13:21
@mapedraza mapedraza changed the base branch from task/doc-rework to master May 9, 2023 13:21
Copy link
Member

@fgalan fgalan left a comment

Choose a reason for hiding this comment

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

LGTM

@fgalan fgalan merged commit 7e3a396 into master May 9, 2023
@fgalan fgalan deleted the task/doc-rework-api branch May 9, 2023 13:43
@fgalan
Copy link
Member

fgalan commented May 9, 2023

We have decided to change base branch from task/doc-rework to master.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants